@alxia/react-router 0.8.1 → 0.10.0

package/README.md

@@ -92,7 +92,10 @@ Vite's preview server, as `bun run start` would: the pages, `/api`, the
 client's files and the app's middlewares. So does React Router's prerendering.
 
 `@alxia/core` and `react-router` 8 are peers, and `vite` 7 or 8 is an
-optional peer, for `/vite`. The package declares no dependency.
+optional peer, for `/vite`; `react` 19 is an optional peer, for `/pwa/react`. The six `workbox-*`
+packages (`workbox-core`, `workbox-expiration`, `workbox-navigation-preload`,
+`workbox-precaching`, `workbox-routing`, `workbox-strategies`) are optional
+peers too, for `/pwa/worker` (the [PWA section](#installable-and-offline-pwa) has the install line). The package declares no dependency.
 
 Its `typescript` peer is 6 or 7. The template's TypeScript 5.9 typechecks,
 but `bun add` warns about it; `bun add -d typescript@^6` silences the
@@ -246,7 +249,7 @@ the `Bun.Server` the app's sockets are relayed to, on a loopback port:
 It is not `Register`'s `server`, which names what `createServer()` returned
 for the types.
 
-[More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md#typing-the-loaders)
+[More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/typing-the-loaders.md#typing-the-loaders)
 
 ## A CSP nonce
 
@@ -293,7 +296,7 @@ bunx react-router reveal entry.server
 `nonceOf` returns `undefined` when no middleware set a nonce, so the entry works
 with or without secure-headers: neither package depends on the other. Any
 `derive` that returns a string `nonce` works the same.
-[More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md#a-csp-nonce)
+[More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/csp-nonce.md#a-csp-nonce)
 
 ## WebSockets
 
@@ -321,7 +324,7 @@ middlewares before the route, a refusal's status, `socket.data`, `publish`. An
 edit to the server is used from the next connection. An action's
 `alxiaOf(context).server.publish` reaches those sockets too
 ([The server](#the-server-server)).
-[More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md#websockets)
+[More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/beside-the-pages.md#websockets)
 
 ## Options
 
@@ -351,7 +354,7 @@ ignored. A server of your own gives `alxia({ proxy })` the same option. [More](h
 `build`, `mode` and `client` override what the plugin wires;
 `client: false` serves no client files, so you can serve them yourself.
 A server of your own, with no plugin, calls `reactRouter(app, { build,
-client })` itself. [More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md#escape-hatches)
+client })` itself. [More](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/customising-the-server.md#escape-hatches)
 
 ## The client's files
 
@@ -439,7 +442,7 @@ export default defineConfig({
 ```
 
 The
-[guide](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md#built-for-bun)
+[guide](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/how-it-works.md#built-for-bun)
 has each option and why.
 
 ## Docker
@@ -474,9 +477,150 @@ docker run -p 3000:3000 my-app
 
 Keep the template's `.dockerignore`, and commit `bun.lock`. The server
 runs as the non-root `bun` user, on `PORT` (3000). The
-[guide](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md#docker)
+[guide](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/deploying.md#docker)
 has the commented file, and what to copy for a package left external.
 
+## Installable and offline (PWA)
+
+`@alxia/react-router/pwa` holds what an installable app shares and that has
+no UI: the service worker's contract, which requests it caches and which
+responses it may store, the precache list read from a build, the
+registration and update notice, the web app manifest, and the cleaning at
+sign-out. It imports nothing, so the worker, a build script, the page and
+the server can all import it. The worker itself is `startWorker` in
+`/pwa/worker`, its build `buildWorker` in `/pwa/build`, the hooks are in
+`/pwa/react` (`react`, an optional peer) and `noCache` in `/pwa/server`; this
+package never reads `import.meta.env`, so the app passes `enabled`.
+
+With `app/service-worker.ts` in the app, `react-router build` writes
+`build/client/service-worker.js` itself: `alxia()` bundles the file after the
+client build, with the precache list written in, and there is no script to
+add. It needs Bun (`bun --bun react-router build`, or a `bunfig.toml` with
+`[run] bun = true`). `alxia({ worker: 'app/pwa/worker.ts' })` names another file
+and `alxia({ worker: false })` builds none.
+
+The worker bundles Workbox, whose six packages are optional peers:
+
+```sh
+bun add -d workbox-core workbox-expiration workbox-navigation-preload workbox-precaching workbox-routing workbox-strategies
+```
+
+```ts
+// file: app/pwa-contract.ts
+// Shared by the worker and the page: every cache is named `my-app-<kind>-<version>`.
+import { defineWorkerContract } from '@alxia/react-router/pwa';
+
+export const workerContract = defineWorkerContract({ cachePrefix: 'my-app' });
+```
+
+```ts
+// file: app/service-worker.ts
+import { startWorker } from '@alxia/react-router/pwa/worker';
+import { workerContract } from './pwa-contract';
+
+startWorker({ contract: workerContract });
+```
+
+```tsx
+// file: app/root.tsx
+import { manifestHref } from '@alxia/react-router/pwa';
+import { useServiceWorker } from '@alxia/react-router/pwa/react';
+import { Outlet } from 'react-router';
+
+// The browser reads the manifest to offer the install.
+export function links() {
+	return [{ rel: 'manifest', href: manifestHref('en') }];
+}
+
+// A production build only, never under `react-router dev`.
+export default function App() {
+	useServiceWorker({ enabled: import.meta.env.PROD });
+	return <Outlet />;
+}
+```
+
+```ts
+// file: app/server.ts
+import { createServer } from '@alxia/react-router';
+import {
+	MANIFEST_HEADERS,
+	MANIFEST_PATH,
+	SERVICE_WORKER_URL,
+	webAppManifest,
+} from '@alxia/react-router/pwa';
+import { noCache } from '@alxia/react-router/pwa/server';
+
+// beforeAll runs before the client's files: the worker's script is
+// revalidated. The manifest is a route, served with its own headers.
+export default createServer({
+	beforeAll: (app) => app.use(SERVICE_WORKER_URL, noCache),
+	configure: (app) =>
+		app.get(MANIFEST_PATH, ({ reply }) => {
+			const manifest = webAppManifest({
+				name: 'My app',
+				description: 'My installable app',
+				lang: 'en',
+				themeColor: '#1e40af',
+				backgroundColor: '#ffffff',
+			});
+			return reply(200, JSON.stringify(manifest), { headers: MANIFEST_HEADERS });
+		}),
+});
+```
+
+The manifest names four icons (`MINIMAL_2023_ICONS`): put
+`pwa-64x64.png`, `pwa-192x192.png`, `pwa-512x512.png` and
+`maskable-icon-512x512.png` in `public/`, which `@vite-pwa/assets-generator`'s
+`minimal2023Preset` writes from one image. A browser offers the install with
+a 192 and a 512.
+
+The worker serves a page load from `public/offline.html` when the network
+fails, and the build needs the file:
+
+```html
+<!-- file: public/offline.html -->
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<meta http-equiv="Content-Security-Policy" content="default-src 'none'" />
+		<title>Offline</title>
+	</head>
+	<body>
+		<h1>You are offline</h1>
+		<p>Check your connection and try again.</p>
+	</body>
+</html>
+```
+
+Set `routeDiscovery: { mode: 'initial' }` in `react-router.config.ts`, so a
+client navigation offline to a route never visited finds its modules
+([more](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/troubleshooting.md#offline-a-client-navigation-to-a-route-never-visited-shows-the-offline-page)):
+
+```ts
+import type { Config } from '@react-router/dev/config';
+
+export default { ssr: true, routeDiscovery: { mode: 'initial' } } satisfies Config;
+```
+
+An app that built its worker with a script of its own has steps to drop:
+[moving from a build script of your own](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/pwa.md#moving-from-a-build-script-of-your-own).
+
+For a build pipeline of your own, `buildWorker` from `/pwa/build` does what
+`alxia()` does. It needs Bun and runs after `react-router build`:
+
+```ts
+// file: scripts/build-worker.ts
+import { buildWorker } from '@alxia/react-router/pwa/build';
+
+await buildWorker({ file: 'app/service-worker.ts' });
+```
+
+The [PWA guide](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/pwa.md)
+has the worker's options, the offline page, the manifest route, the update
+banner and the rest.
+
 ## Traps
 
 - **A context key made in `app/` reaches the loaders only through the
@@ -527,8 +671,70 @@ From `@alxia/react-router/vite`:
 
 | export | |
 | --- | --- |
-| `alxia(options?)` | the Vite plugin, for `react-router dev`, `react-router build` and `vite preview`, building the server for Bun. `entry` is the server file: `app/server.ts` by default, or the default server when there is none |
-| `AlxiaOptions` | its options |
+| `alxia(options?)` | the Vite plugin, for `react-router dev`, `react-router build` and `vite preview`, building the server for Bun. `entry` is the server file: `app/server.ts` by default, or the default server when there is none. `worker` is the service worker built after `react-router build`: `app/service-worker.ts` by default when it exists, a file, `AlxiaWorkerOptions`, or `false` |
+| `AlxiaOptions`, `AlxiaWorkerOptions` | its options, and the worker's (`buildWorker()`'s but `root`, `client` and `file`, which is optional) |
+
+From `@alxia/react-router/pwa`:
+
+| export | |
+| --- | --- |
+| `defineWorkerContract(options)` | the contract of one app's worker from its `cachePrefix` (required), with `cacheVersion` (`v1`), `serviceWorkerUrl` and `offlineUrl`: its `cacheNames`, `obsoleteCaches(names)` and `clearableCaches(names)`. Throws on an empty prefix or one ending with `-`, and on an empty `cacheVersion` or one with a `-` |
+| `WorkerContract`, `WorkerContractOptions`, `CacheNames` | its types |
+| `SERVICE_WORKER_URL`, `OFFLINE_URL`, `SKIP_WAITING` | `/service-worker.js`, `/offline.html` and the message that applies an update |
+| `cachingFor(request, origin, options?)` | `navigation`, `immutable`, `static` or `none` for a request. `options`: `never(path)`, `immutable(path)` (everything under `/assets/` by default), `serviceWorkerUrl`, `contract` (whose `serviceWorkerUrl` is never cached), `manifestPath` |
+| `Caching`, `RequestFacts`, `CachingOptions` | its types |
+| `isStorable(response)` | whether a response may be stored: a full, same-origin, `public` 200 of a script, style, font or image, not varying on who asks |
+| `parseBrowserManifest(source)` | React Router's browser manifest, read from `build/client/assets/manifest-*.js` |
+| `precacheList(manifest)` | the hashed scripts and stylesheets every route needs, as Workbox precache entries |
+| `assetPrecache(files, include, base?)` | the entries of the files in `build/client/assets` that a regex of yours matches, such as fonts |
+| `BrowserManifest`, `PrecacheEntry` | their types |
+| `clearAppCaches(contract)` | deletes the caches the worker filled but the offline page; for sign-out. Does nothing without Cache Storage |
+| `registerServiceWorker(container, onWaiting, options?)` | registers the worker (`url`, `scope` options) and calls `onWaiting(worker, apply)` for each new version waiting behind a controller; checks for an update when the tab shows again. `apply` activates the worker and reloads once |
+| `watchForUpdates(registration, container, onWaiting)`, `createUpdater(container, reload?)`, `afterLoad(run)` | its parts: offering waiting workers, the one update path of a page, and running once the page has loaded |
+| `ApplyUpdate`, `RegisterOptions`, `ServiceWorkerContainerLike` | their types |
+| `createUpdateNotice(storage, key?)` | the update notice's store (`offer`, `current`, `subscribe`, as `useSyncExternalStore` takes it): hidden for the session by "Later", kept in `storage()`, which may be missing or throw |
+| `UpdateNotice`, `UpdateNoticeStore`, `NoticeStorage` | its types. `NoticeStorage` is any object with `getItem(key)` and `setItem(key, value)` |
+| `sessionStore`, `UPDATE_LATER_KEY` | `sessionStorage` or nothing, and the default key, `alxia.update-later` |
+| `MANIFEST_PATH`, `MANIFEST_HEADERS` | `/manifest.webmanifest`, and the headers to serve it with: cacheable for an hour, varying on `Accept-Language`, a policy that loads nothing |
+| `webAppManifest(options)` | the web app manifest's JSON from the app's `name`, `description`, `lang`, `themeColor`, `backgroundColor` and the optional rest; `id`, `start_url` and `scope` are `/` in every language |
+| `WebAppManifest`, `WebAppManifestOptions`, `ManifestIcon` | its types |
+| `MINIMAL_2023_ICONS` | the four icons `@vite-pwa/assets-generator`'s `minimal2023Preset` writes |
+| `manifestHref(language, path?)` | the manifest's URL for a page: `/manifest.webmanifest?lang=fr` |
+| `manifestLanguage(url, supported, fallback)` | `?lang=` when it is one of `supported`, else `fallback` |
+
+From `@alxia/react-router/pwa/react` (`react`, an optional peer, is its only package import):
+
+| export | |
+| --- | --- |
+| `useOnline()` | whether the browser says it is online; online on the server and while hydrating |
+| `useServiceWorker(options)` | registers the worker after `load` when `options.enabled` (required; the app passes `import.meta.env.PROD`), in a browser that has one. `url`, `scope`, `notice` (where a waiting version is offered), `onError` (registering failed; dropped by default) |
+| `ServiceWorkerOptions` | its options |
+| `useUpdateNotice(notice?)` | the `{ reload, later }` to show while a new version waits and "Later" was not asked, else `undefined`; always `undefined` on the server |
+| `updateNotice` | the page's one `UpdateNoticeStore`, which `useServiceWorker` offers and `useUpdateNotice` reads by default |
+
+From `@alxia/react-router/pwa/server` (`@alxia/core` is its only package import):
+
+| export | |
+| --- | --- |
+| `noCache` | a middleware: the response it wraps gets `Cache-Control: no-cache` and the worker's policy. For `use(SERVICE_WORKER_URL, noCache)` in `beforeAll` |
+| `revalidated(response, policy?)` | a response with those two headers set, on a copy when its headers are immutable; `policy` is `WORKER_POLICY` by default |
+| `WORKER_POLICY` | `default-src 'none'; connect-src 'self'`: the worker runs no other script and fetches this site only |
+
+From `@alxia/react-router/pwa/worker` (the six `workbox-*` packages, optional peers, are its only package imports):
+
+| export | |
+| --- | --- |
+| `startWorker(options)` | the worker's strategies: the precache route, `NetworkOnly` for a page load with the precached offline page as its fallback, `CacheFirst` for hashed bundles, `StaleWhileRevalidate` for other static files (both storing only what `isStorable` accepts), the obsolete caches swept on `activate`, and `SKIP_WAITING` applied |
+| `WorkerOptions` | `contract` (required), `caching`, `assets`, `static`, `navigationPreload`, `precache` |
+| `ExpirationOptions` | `{ maxEntries?, maxAgeSeconds? }` |
+
+From `@alxia/react-router/pwa/build` (Bun; Node's built-ins its only imports):
+
+| export | |
+| --- | --- |
+| `buildWorker(options)` | bundles the worker into `build/client/service-worker.js` with its precache list (the offline page by its content, every route's code, `precacheAssets`), after `react-router build` |
+| `BuildWorkerOptions` | `file` (required), `root`, `client`, `contract`, `offline`, `precacheAssets`, `minify` |
+| `WorkerBuild` | `{ file, precache, precacheBytes, bytes }` |
 
 The `alxia-react-router` bin, run with `bunx`:
 
@@ -538,7 +744,13 @@ The `alxia-react-router` bin, run with `bunx`:
 
 ## Documentation
 
-- [Guide](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide.md): the setup, how dev, the build and `vite preview` work, what the build sets for Bun, customising the server, typing the loaders, the app's own keys, a CSP nonce, escape hatches, WebSockets, the client's files, OpenAPI, testing and deploying, with Docker.
+- [Documentation index](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/README.md): every page, and when to read it.
+- [Getting started](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/getting-started.md): a new app, the official template or an existing app.
+- [How it works](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/how-it-works.md): dev, the build and `vite preview`, and what the build sets for Bun.
+- [Customising the server](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/customising-the-server.md): `createServer()`, and the escape hatches.
+- [Typing the loaders](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/typing-the-loaders.md): `Register`, and the app's own context keys.
+- [A CSP nonce](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/csp-nonce.md), [Beside the pages](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/beside-the-pages.md) (middlewares, routes, WebSockets, the client's files), [OpenAPI](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/openapi.md), [Testing](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/testing.md) and [Deploying](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/deploying.md), with Docker.
+- [Installable and offline](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/guide/pwa.md): what the subpaths hold, the worker's contract, the worker, what it caches, the offline page, building the worker with `alxia()` or `buildWorker`, the hooks in React, registering the worker and offering an update, serving the worker's script, the web app manifest, and clearing at sign-out.
 - [Troubleshooting](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/troubleshooting.md): each message, and the traps that print none.
 - [Roadmap](https://github.com/softistx/alxia/blob/develop/packages/react-router/docs/roadmap.md): what is coming, and what is not planned.
 - [Example](https://github.com/softistx/alxia/tree/develop/examples/react-router): the official template, these four changes, then an `app/server.ts` with a session, an `/api`, secure headers with a nonce and a streamed page.

package/dist/chunks/index-59vhfj6n.js

@@ -0,0 +1,10 @@
+// src/pwa/worker/injected.ts
+var PRECACHE_DEFINE = "globalThis.__ALXIA_PRECACHE__";
+function injectedPrecache() {
+  return globalThis.__ALXIA_PRECACHE__;
+}
+
+export { PRECACHE_DEFINE, injectedPrecache };
+
+//# debugId=CA917CBC5F688F4264756E2164756E21
+//# sourceMappingURL=index-59vhfj6n.js.map

package/dist/chunks/index-59vhfj6n.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/pwa/worker/injected.ts"],
+  "sourcesContent": [
+    "/** The define key the build sets: the worker's precache list, as JSON. */\nexport const PRECACHE_DEFINE = 'globalThis.__ALXIA_PRECACHE__';\n\n/** One file the worker precaches: its URL and a revision (`null` when hashed in the name). */\ntype Entry = { readonly url: string; readonly revision: string | null };\n\n/**\n * The precache list the build wrote into this worker, or `undefined` when the\n * worker did not go through the build. Read through `globalThis`, so a missing\n * define is `undefined`, never a `ReferenceError`.\n */\nexport function injectedPrecache(): readonly Entry[] | undefined {\n\treturn (globalThis as { __ALXIA_PRECACHE__?: readonly Entry[] })\n\t\t.__ALXIA_PRECACHE__;\n}\n"
+  ],
+  "mappings": ";AACO,IAAM,kBAAkB;AAUxB,SAAS,gBAAgB,GAAiC;AAAA,EAChE,OAAQ,WACN;AAAA;",
+  "debugId": "CA917CBC5F688F4264756E2164756E21",
+  "names": []
+}

package/dist/chunks/index-5gqcpyyg.js

@@ -0,0 +1,34 @@
+// src/pwa/model/precache-list.ts
+var HASHED_ASSET = /^\/assets\/[^/]+-[\w-]{8}\.(?:js|css)$/;
+function parseBrowserManifest2(source) {
+  const start = source.indexOf("{");
+  const end = source.lastIndexOf("}");
+  if (start < 0 || end < start) {
+    throw new Error("parseBrowserManifest(): not React Router's browser manifest (build/client/assets/manifest-*.js).");
+  }
+  return JSON.parse(source.slice(start, end + 1));
+}
+function precacheList2(manifest) {
+  const urls = new Set([manifest.url]);
+  for (const part of [manifest.entry, ...Object.values(manifest.routes)]) {
+    for (const url of [
+      ...part.module ? [part.module] : [],
+      ...part.imports ?? [],
+      ...part.css ?? []
+    ]) {
+      urls.add(url);
+    }
+  }
+  return [...urls].filter((url) => HASHED_ASSET.test(url)).map((url) => ({ url, revision: null }));
+}
+function assetPrecache2(assetFiles, include, base = "/assets/") {
+  return assetFiles.filter((file) => {
+    include.lastIndex = 0;
+    return include.test(file);
+  }).sort().map((file) => ({ url: `${base}${file}`, revision: null }));
+}
+
+export { parseBrowserManifest2, precacheList2, assetPrecache2 };
+
+//# debugId=812DDA9793A6A64B64756E2164756E21
+//# sourceMappingURL=index-5gqcpyyg.js.map

package/dist/chunks/index-5gqcpyyg.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/pwa/model/precache-list.ts"],
+  "sourcesContent": [
+    "/**\n * What the service worker precaches, read from a build: every script and\n * stylesheet React Router's manifest names (the client entry and each\n * route's module, imports and CSS), and the manifest itself, so a client\n * navigation offline to a route never visited still finds its code. Only\n * hashed `/assets/` files: a new build names new files, so each precaches\n * under its own URL, revision `null`. Chunks only a component loads on\n * demand stay out: a cache-first route stores them the first time they load.\n *\n * Dependency-free: a build script runs it at build time.\n */\n\n/** A route or the entry, as `window.__reactRouterManifest` lists it. */\ntype ManifestModule = { module?: string; imports?: string[]; css?: string[] };\n\n/** The parts of React Router's browser manifest the list reads. */\nexport type BrowserManifest = {\n\turl: string;\n\tentry: ManifestModule;\n\troutes: Record<string, ManifestModule>;\n};\n\n/** A Workbox precache entry: a hashed URL needs no revision. */\nexport type PrecacheEntry = { url: string; revision: string | null };\n\n/** A Vite-hashed file under `/assets/`: `name-<8 hash chars>.js|css`. */\nconst HASHED_ASSET = /^\\/assets\\/[^/]+-[\\w-]{8}\\.(?:js|css)$/;\n\n/** Reads `window.__reactRouterManifest={…};` (build/client/assets/manifest-*.js). */\nexport function parseBrowserManifest(source: string): BrowserManifest {\n\tconst start = source.indexOf('{');\n\tconst end = source.lastIndexOf('}');\n\tif (start < 0 || end < start) {\n\t\tthrow new Error(\n\t\t\t\"parseBrowserManifest(): not React Router's browser manifest (build/client/assets/manifest-*.js).\",\n\t\t);\n\t}\n\treturn JSON.parse(source.slice(start, end + 1)) as BrowserManifest;\n}\n\n/** The hashed scripts and stylesheets every route needs, the manifest's own file first. */\nexport function precacheList(manifest: BrowserManifest): PrecacheEntry[] {\n\tconst urls = new Set<string>([manifest.url]);\n\tfor (const part of [manifest.entry, ...Object.values(manifest.routes)]) {\n\t\tfor (const url of [\n\t\t\t...(part.module ? [part.module] : []),\n\t\t\t...(part.imports ?? []),\n\t\t\t...(part.css ?? []),\n\t\t]) {\n\t\t\turls.add(url);\n\t\t}\n\t}\n\treturn [...urls]\n\t\t.filter((url) => HASHED_ASSET.test(url))\n\t\t.map((url) => ({ url, revision: null }));\n}\n\n/**\n * The precache entries of the files among `assetFiles` (the names in\n * build/client/assets) that `include` matches, sorted, under `base`: fonts\n * an app keeps offline, say. The regex is the app's.\n */\nexport function assetPrecache(\n\tassetFiles: readonly string[],\n\tinclude: RegExp,\n\tbase = '/assets/',\n): PrecacheEntry[] {\n\treturn assetFiles\n\t\t.filter((file) => {\n\t\t\tinclude.lastIndex = 0; // a /g or /y regex remembers its last match\n\t\t\treturn include.test(file);\n\t\t})\n\t\t.sort()\n\t\t.map((file) => ({ url: `${base}${file}`, revision: null }));\n}\n"
+  ],
+  "mappings": ";AA0BA,IAAM,eAAe;AAGd,SAAS,qBAAoB,CAAC,QAAiC;AAAA,EACrE,MAAM,QAAQ,OAAO,QAAQ,GAAG;AAAA,EAChC,MAAM,MAAM,OAAO,YAAY,GAAG;AAAA,EAClC,IAAI,QAAQ,KAAK,MAAM,OAAO;AAAA,IAC7B,MAAM,IAAI,MACT,kGACD;AAAA,EACD;AAAA,EACA,OAAO,KAAK,MAAM,OAAO,MAAM,OAAO,MAAM,CAAC,CAAC;AAAA;AAIxC,SAAS,aAAY,CAAC,UAA4C;AAAA,EACxE,MAAM,OAAO,IAAI,IAAY,CAAC,SAAS,GAAG,CAAC;AAAA,EAC3C,WAAW,QAAQ,CAAC,SAAS,OAAO,GAAG,OAAO,OAAO,SAAS,MAAM,CAAC,GAAG;AAAA,IACvE,WAAW,OAAO;AAAA,MACjB,GAAI,KAAK,SAAS,CAAC,KAAK,MAAM,IAAI,CAAC;AAAA,MACnC,GAAI,KAAK,WAAW,CAAC;AAAA,MACrB,GAAI,KAAK,OAAO,CAAC;AAAA,IAClB,GAAG;AAAA,MACF,KAAK,IAAI,GAAG;AAAA,IACb;AAAA,EACD;AAAA,EACA,OAAO,CAAC,GAAG,IAAI,EACb,OAAO,CAAC,QAAQ,aAAa,KAAK,GAAG,CAAC,EACtC,IAAI,CAAC,SAAS,EAAE,KAAK,UAAU,KAAK,EAAE;AAAA;AAQlC,SAAS,cAAa,CAC5B,YACA,SACA,OAAO,YACW;AAAA,EAClB,OAAO,WACL,OAAO,CAAC,SAAS;AAAA,IACjB,QAAQ,YAAY;AAAA,IACpB,OAAO,QAAQ,KAAK,IAAI;AAAA,GACxB,EACA,KAAK,EACL,IAAI,CAAC,UAAU,EAAE,KAAK,GAAG,OAAO,QAAQ,UAAU,KAAK,EAAE;AAAA;",
+  "debugId": "812DDA9793A6A64B64756E2164756E21",
+  "names": []
+}

package/dist/chunks/index-9xv2a8et.js

@@ -0,0 +1,108 @@
+import {
+  SERVICE_WORKER_URL2,
+  SKIP_WAITING2
+} from "./index-rfr02vg4.js";
+
+// src/pwa/model/registration.ts
+function watchForUpdates2(registration, container, onWaiting) {
+  const offer = (worker) => {
+    if (worker && container.controller)
+      onWaiting(worker);
+  };
+  offer(registration.waiting);
+  registration.addEventListener("updatefound", () => {
+    const installing = registration.installing;
+    installing?.addEventListener("statechange", () => {
+      if (installing.state === "installed")
+        offer(installing);
+    });
+  });
+}
+function createUpdater2(container, reload = () => window.location.reload()) {
+  let requested = false;
+  let reloaded = false;
+  const reloadOnce = () => {
+    if (reloaded)
+      return;
+    reloaded = true;
+    reload();
+  };
+  container.addEventListener("controllerchange", () => {
+    if (requested)
+      reloadOnce();
+  });
+  return (worker) => {
+    const active = worker.state === "activating" || worker.state === "activated" || container.controller === worker;
+    if (active)
+      return reloadOnce();
+    requested = true;
+    worker.postMessage({ type: SKIP_WAITING2 });
+  };
+}
+function afterLoad2(run) {
+  if (document.readyState === "complete")
+    run();
+  else
+    window.addEventListener("load", run, { once: true });
+}
+var updater;
+async function registerServiceWorker2(container, onWaiting, options = {}) {
+  updater ??= createUpdater2(container);
+  const apply = updater;
+  const registration = await container.register(options.url ?? SERVICE_WORKER_URL2, { scope: options.scope ?? "/" });
+  watchForUpdates2(registration, container, (worker) => onWaiting(worker, apply));
+  document.addEventListener("visibilitychange", () => {
+    if (document.visibilityState === "visible")
+      registration.update().catch(() => {});
+  });
+  return registration;
+}
+
+// src/pwa/model/update-notice.ts
+var UPDATE_LATER_KEY2 = "alxia.update-later";
+function createUpdateNotice2(storage, key = UPDATE_LATER_KEY2) {
+  let reload;
+  let laterThisPage = false;
+  let notice;
+  const listeners = new Set;
+  const later = () => {
+    laterThisPage = true;
+    try {
+      storage()?.setItem(key, "1");
+    } catch {}
+    refresh();
+  };
+  const laterAsked = () => {
+    if (laterThisPage)
+      return true;
+    try {
+      return storage()?.getItem(key) === "1";
+    } catch {
+      return false;
+    }
+  };
+  function refresh() {
+    notice = reload && !laterAsked() ? { reload, later } : undefined;
+    for (const listener of listeners)
+      listener();
+  }
+  return {
+    offer(apply) {
+      reload = apply;
+      refresh();
+    },
+    current: () => notice,
+    subscribe(listener) {
+      listeners.add(listener);
+      return () => {
+        listeners.delete(listener);
+      };
+    }
+  };
+}
+var sessionStore2 = () => typeof sessionStorage === "undefined" ? undefined : sessionStorage;
+
+export { watchForUpdates2, createUpdater2, afterLoad2, registerServiceWorker2, UPDATE_LATER_KEY2, createUpdateNotice2, sessionStore2 };
+
+//# debugId=824F7298E795FD3C64756E2164756E21
+//# sourceMappingURL=index-9xv2a8et.js.map

package/dist/chunks/index-9xv2a8et.js.map

@@ -0,0 +1,11 @@
+{
+  "version": 3,
+  "sources": ["../src/pwa/model/registration.ts", "../src/pwa/model/update-notice.ts"],
+  "sourcesContent": [
+    "import { SERVICE_WORKER_URL, SKIP_WAITING } from './worker-contract';\n\n/** What the registration reads of `navigator.serviceWorker`. */\nexport type ServiceWorkerContainerLike = Pick<\n\tServiceWorkerContainer,\n\t'controller' | 'addEventListener' | 'register'\n>;\n\n/**\n * Calls `onWaiting` with each new version that finished installing while an\n * older one controls the page: the one waiting now, and each found later.\n * A first install controls nothing yet, so it offers nothing.\n */\nexport function watchForUpdates(\n\tregistration: ServiceWorkerRegistration,\n\tcontainer: Pick<ServiceWorkerContainerLike, 'controller'>,\n\tonWaiting: (worker: ServiceWorker) => void,\n): void {\n\tconst offer = (worker: ServiceWorker | null) => {\n\t\tif (worker && container.controller) onWaiting(worker);\n\t};\n\toffer(registration.waiting);\n\tregistration.addEventListener('updatefound', () => {\n\t\tconst installing = registration.installing;\n\t\tinstalling?.addEventListener('statechange', () => {\n\t\t\tif (installing.state === 'installed') offer(installing);\n\t\t});\n\t});\n}\n\n/** Moves this page onto a waiting worker: `apply(worker)`. */\nexport type ApplyUpdate = (\n\tworker: Pick<ServiceWorker, 'postMessage' | 'state'>,\n) => void;\n\n/**\n * The one update path of a page, created once: `apply(worker)` activates\n * the waiting worker and reloads once, when it takes control, so the page\n * runs the version its assets came from.\n *\n * - Several tabs: another tab may have activated the worker already. Its\n *   `controllerchange` reached this page before anyone asked, so this page\n *   did not reload (a form may be half filled); its \"Reload\" then reloads\n *   at once, the worker being active.\n * - Clicked twice, or a `controllerchange` after a direct reload: one\n *   reload, never two.\n */\nexport function createUpdater(\n\tcontainer: Pick<\n\t\tServiceWorkerContainerLike,\n\t\t'controller' | 'addEventListener'\n\t>,\n\treload: () => void = () => window.location.reload(),\n): ApplyUpdate {\n\tlet requested = false;\n\tlet reloaded = false;\n\tconst reloadOnce = () => {\n\t\tif (reloaded) return;\n\t\treloaded = true;\n\t\treload();\n\t};\n\tcontainer.addEventListener('controllerchange', () => {\n\t\tif (requested) reloadOnce();\n\t});\n\treturn (worker) => {\n\t\tconst active =\n\t\t\tworker.state === 'activating' ||\n\t\t\tworker.state === 'activated' ||\n\t\t\tcontainer.controller === worker;\n\t\tif (active) return reloadOnce();\n\t\trequested = true;\n\t\tworker.postMessage({ type: SKIP_WAITING });\n\t};\n}\n\n/** Runs `run` once the page has loaded: registering never competes with it. */\nexport function afterLoad(run: () => void): void {\n\tif (document.readyState === 'complete') run();\n\telse window.addEventListener('load', run, { once: true });\n}\n\nexport interface RegisterOptions {\n\t/** The worker's path. `SERVICE_WORKER_URL` by default. */\n\turl?: string;\n\t/** The scope it controls. `'/'` by default. */\n\tscope?: string;\n}\n\nlet updater: ApplyUpdate | undefined;\n\n/**\n * Registers the worker and watches for updates, handing each waiting worker\n * to `onWaiting` with the page's one `apply` (`createUpdater`, made on the\n * first call: one per page). A tab coming back to the foreground checks for\n * an update, as a long-lived page otherwise would only on its next full load.\n */\nexport async function registerServiceWorker(\n\tcontainer: ServiceWorkerContainerLike,\n\tonWaiting: (worker: ServiceWorker, apply: ApplyUpdate) => void,\n\toptions: RegisterOptions = {},\n): Promise<ServiceWorkerRegistration> {\n\tupdater ??= createUpdater(container);\n\tconst apply = updater;\n\tconst registration = await container.register(\n\t\toptions.url ?? SERVICE_WORKER_URL,\n\t\t{ scope: options.scope ?? '/' },\n\t);\n\twatchForUpdates(registration, container, (worker) =>\n\t\tonWaiting(worker, apply),\n\t);\n\tdocument.addEventListener('visibilitychange', () => {\n\t\tif (document.visibilityState === 'visible')\n\t\t\tregistration.update().catch(() => {\n\t\t\t\t// Offline, or the server is down: the next check will tell.\n\t\t\t});\n\t});\n\treturn registration;\n}\n",
+    "/**\n * The session's \"Later\": the notice stays hidden until the next visit.\n * `sessionStorage` is per origin, so one key serves every app; a second\n * argument of `createUpdateNotice` names another.\n */\nexport const UPDATE_LATER_KEY = 'alxia.update-later';\n\n/** The part of `Storage` the notice reads and writes. */\nexport type NoticeStorage = {\n\tgetItem(key: string): string | null;\n\tsetItem(key: string, value: string): void;\n};\n\n/** What the notice offers while a new version waits. */\nexport type UpdateNotice = {\n\t/** Moves the page onto the new version: the worker's `apply`. */\n\treload: () => void;\n\t/** Hides the notice until the next visit (the tab's session). */\n\tlater: () => void;\n};\n\n/** What `createUpdateNotice` returns: the shape `useSyncExternalStore` takes. */\nexport interface UpdateNoticeStore {\n\t/** A new version waits: `apply` moves the page onto it. */\n\toffer(apply: () => void): void;\n\t/** The notice to show, if any (the same object until it changes). */\n\tcurrent(): UpdateNotice | undefined;\n\t/** Calls `listener` on each change; returns the function that stops it. */\n\tsubscribe(listener: () => void): () => void;\n}\n\n/**\n * The update notice's state: offered by the worker's registration, read by\n * the banners, hidden for the session by \"Later\". `storage` is the session's\n * (`sessionStorage`), which may be missing or throw (private mode, blocked\n * storage): the notice then hides for this page only. It is a function so\n * that nothing reads the global at load.\n */\nexport function createUpdateNotice(\n\tstorage: () => NoticeStorage | undefined,\n\tkey: string = UPDATE_LATER_KEY,\n): UpdateNoticeStore {\n\tlet reload: (() => void) | undefined;\n\tlet laterThisPage = false;\n\tlet notice: UpdateNotice | undefined;\n\tconst listeners = new Set<() => void>();\n\n\tconst later = () => {\n\t\tlaterThisPage = true;\n\t\ttry {\n\t\t\tstorage()?.setItem(key, '1');\n\t\t} catch {\n\t\t\t// No storage: hidden for this page only.\n\t\t}\n\t\trefresh();\n\t};\n\tconst laterAsked = () => {\n\t\tif (laterThisPage) return true;\n\t\ttry {\n\t\t\treturn storage()?.getItem(key) === '1';\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t};\n\tfunction refresh() {\n\t\tnotice = reload && !laterAsked() ? { reload, later } : undefined;\n\t\tfor (const listener of listeners) listener();\n\t}\n\n\treturn {\n\t\toffer(apply) {\n\t\t\treload = apply;\n\t\t\trefresh();\n\t\t},\n\t\tcurrent: () => notice,\n\t\tsubscribe(listener) {\n\t\t\tlisteners.add(listener);\n\t\t\treturn () => {\n\t\t\t\tlisteners.delete(listener);\n\t\t\t};\n\t\t},\n\t};\n}\n\n/** `sessionStorage`, or nothing where there is none (the server). */\nexport const sessionStore = (): NoticeStorage | undefined =>\n\ttypeof sessionStorage === 'undefined' ? undefined : sessionStorage;\n"
+  ],
+  "mappings": ";;;;;;AAaO,SAAS,gBAAe,CAC9B,cACA,WACA,WACO;AAAA,EACP,MAAM,QAAQ,CAAC,WAAiC;AAAA,IAC/C,IAAI,UAAU,UAAU;AAAA,MAAY,UAAU,MAAM;AAAA;AAAA,EAErD,MAAM,aAAa,OAAO;AAAA,EAC1B,aAAa,iBAAiB,eAAe,MAAM;AAAA,IAClD,MAAM,aAAa,aAAa;AAAA,IAChC,YAAY,iBAAiB,eAAe,MAAM;AAAA,MACjD,IAAI,WAAW,UAAU;AAAA,QAAa,MAAM,UAAU;AAAA,KACtD;AAAA,GACD;AAAA;AAoBK,SAAS,cAAa,CAC5B,WAIA,SAAqB,MAAM,OAAO,SAAS,OAAO,GACpC;AAAA,EACd,IAAI,YAAY;AAAA,EAChB,IAAI,WAAW;AAAA,EACf,MAAM,aAAa,MAAM;AAAA,IACxB,IAAI;AAAA,MAAU;AAAA,IACd,WAAW;AAAA,IACX,OAAO;AAAA;AAAA,EAER,UAAU,iBAAiB,oBAAoB,MAAM;AAAA,IACpD,IAAI;AAAA,MAAW,WAAW;AAAA,GAC1B;AAAA,EACD,OAAO,CAAC,WAAW;AAAA,IAClB,MAAM,SACL,OAAO,UAAU,gBACjB,OAAO,UAAU,eACjB,UAAU,eAAe;AAAA,IAC1B,IAAI;AAAA,MAAQ,OAAO,WAAW;AAAA,IAC9B,YAAY;AAAA,IACZ,OAAO,YAAY,EAAE,MAAM,cAAa,CAAC;AAAA;AAAA;AAKpC,SAAS,UAAS,CAAC,KAAuB;AAAA,EAChD,IAAI,SAAS,eAAe;AAAA,IAAY,IAAI;AAAA,EACvC;AAAA,WAAO,iBAAiB,QAAQ,KAAK,EAAE,MAAM,KAAK,CAAC;AAAA;AAUzD,IAAI;AAQJ,eAAsB,sBAAqB,CAC1C,WACA,WACA,UAA2B,CAAC,GACS;AAAA,EACrC,YAAY,eAAc,SAAS;AAAA,EACnC,MAAM,QAAQ;AAAA,EACd,MAAM,eAAe,MAAM,UAAU,SACpC,QAAQ,OAAO,qBACf,EAAE,OAAO,QAAQ,SAAS,IAAI,CAC/B;AAAA,EACA,iBAAgB,cAAc,WAAW,CAAC,WACzC,UAAU,QAAQ,KAAK,CACxB;AAAA,EACA,SAAS,iBAAiB,oBAAoB,MAAM;AAAA,IACnD,IAAI,SAAS,oBAAoB;AAAA,MAChC,aAAa,OAAO,EAAE,MAAM,MAAM,EAEjC;AAAA,GACF;AAAA,EACD,OAAO;AAAA;;;AC/GD,IAAM,oBAAmB;AAiCzB,SAAS,mBAAkB,CACjC,SACA,MAAc,mBACM;AAAA,EACpB,IAAI;AAAA,EACJ,IAAI,gBAAgB;AAAA,EACpB,IAAI;AAAA,EACJ,MAAM,YAAY,IAAI;AAAA,EAEtB,MAAM,QAAQ,MAAM;AAAA,IACnB,gBAAgB;AAAA,IAChB,IAAI;AAAA,MACH,QAAQ,GAAG,QAAQ,KAAK,GAAG;AAAA,MAC1B,MAAM;AAAA,IAGR,QAAQ;AAAA;AAAA,EAET,MAAM,aAAa,MAAM;AAAA,IACxB,IAAI;AAAA,MAAe,OAAO;AAAA,IAC1B,IAAI;AAAA,MACH,OAAO,QAAQ,GAAG,QAAQ,GAAG,MAAM;AAAA,MAClC,MAAM;AAAA,MACP,OAAO;AAAA;AAAA;AAAA,EAGT,SAAS,OAAO,GAAG;AAAA,IAClB,SAAS,UAAU,CAAC,WAAW,IAAI,EAAE,QAAQ,MAAM,IAAI;AAAA,IACvD,WAAW,YAAY;AAAA,MAAW,SAAS;AAAA;AAAA,EAG5C,OAAO;AAAA,IACN,KAAK,CAAC,OAAO;AAAA,MACZ,SAAS;AAAA,MACT,QAAQ;AAAA;AAAA,IAET,SAAS,MAAM;AAAA,IACf,SAAS,CAAC,UAAU;AAAA,MACnB,UAAU,IAAI,QAAQ;AAAA,MACtB,OAAO,MAAM;AAAA,QACZ,UAAU,OAAO,QAAQ;AAAA;AAAA;AAAA,EAG5B;AAAA;AAIM,IAAM,gBAAe,MAC3B,OAAO,mBAAmB,cAAc,YAAY;",
+  "debugId": "824F7298E795FD3C64756E2164756E21",
+  "names": []
+}

package/dist/chunks/index-mppz0806.js

@@ -0,0 +1,119 @@
+import {
+  parseBrowserManifest2,
+  precacheList2,
+  assetPrecache2
+} from "./index-5gqcpyyg.js";
+import {
+  PRECACHE_DEFINE
+} from "./index-59vhfj6n.js";
+import {
+  SERVICE_WORKER_URL2,
+  OFFLINE_URL2
+} from "./index-rfr02vg4.js";
+
+// src/pwa/build/build-worker.ts
+import { existsSync } from "node:fs";
+import { readdir, readFile, stat } from "node:fs/promises";
+import { basename, dirname, join, resolve, sep } from "node:path";
+
+// src/pwa/build/precache.ts
+import { createHash } from "node:crypto";
+function browserManifestFile(files) {
+  const found = files.filter((file) => /^manifest-[\w-]+\.js$/.test(file));
+  const [only] = found;
+  if (found.length !== 1 || only === undefined) {
+    throw new Error(`buildWorker(): expected one React Router browser manifest, build/client/assets/manifest-*.js, found ${found.length}. Run react-router build first.`);
+  }
+  return only;
+}
+function revisionOf(bytes) {
+  return createHash("sha256").update(bytes).digest("hex").slice(0, 16);
+}
+function workerPrecache(input) {
+  const all = [
+    ...input.offline ? [input.offline] : [],
+    ...precacheList2(parseBrowserManifest2(input.manifestSource)),
+    ...input.include ? assetPrecache2(input.assetFiles, input.include) : []
+  ];
+  const seen = new Set;
+  return all.filter(({ url }) => !seen.has(url) && seen.add(url));
+}
+
+// src/pwa/build/build-worker.ts
+function assertBun(onBun = globalThis.Bun !== undefined) {
+  if (onBun)
+    return;
+  throw new Error("buildWorker() runs on Bun: it is running on Node. Run it with bun, or run react-router build with bun --bun.");
+}
+function urlInClient(client, url) {
+  const path = join(client, url);
+  if (!url.startsWith("/") || /^[a-z][a-z0-9+.-]*:|^\/\//i.test(url) || !path.startsWith(client + sep) || path.endsWith(sep)) {
+    throw new Error(`buildWorker(): ${url} is outside ${client}.`);
+  }
+  return path;
+}
+async function buildWorker2(options) {
+  assertBun();
+  const root = resolve(options.root ?? process.cwd());
+  const client = resolve(root, options.client ?? "build/client");
+  const source = resolve(root, options.file);
+  const workerUrl = options.contract?.serviceWorkerUrl ?? SERVICE_WORKER_URL2;
+  const offlineUrl = options.contract?.offlineUrl ?? OFFLINE_URL2;
+  if (!existsSync(source)) {
+    throw new Error(`buildWorker(): ${options.file} does not exist.`);
+  }
+  const assets = join(client, "assets");
+  const files = await readdir(assets).catch(() => []);
+  const manifest = browserManifestFile(files);
+  let offline;
+  if (options.offline !== false) {
+    const page = urlInClient(client, offlineUrl);
+    if (!existsSync(page)) {
+      throw new Error(`buildWorker(): ${options.client ?? "build/client"}${offlineUrl} does not exist. Add public${offlineUrl}, or pass offline: false (\`worker: { offline: false }\` in alxia()), or pass the app's contract (\`worker: { contract }\` in alxia()).`);
+    }
+    offline = { url: offlineUrl, revision: revisionOf(await readFile(page)) };
+  }
+  const precache = workerPrecache({
+    manifestSource: await readFile(join(assets, manifest), "utf8"),
+    assetFiles: files,
+    offline,
+    include: options.precacheAssets
+  });
+  const out = urlInClient(client, workerUrl);
+  const result = await Bun.build({
+    entrypoints: [source],
+    outdir: dirname(out),
+    naming: basename(out),
+    target: "browser",
+    format: "iife",
+    minify: options.minify ?? true,
+    define: {
+      "process.env.NODE_ENV": '"production"',
+      [PRECACHE_DEFINE]: JSON.stringify(precache)
+    }
+  }).catch((error) => {
+    const detail = error instanceof AggregateError ? error.errors.map(String).join(`
+`) : String(error);
+    throw new Error(`buildWorker(): Bun.build failed:
+${detail}`);
+  });
+  if (!result.success) {
+    throw new Error(`buildWorker(): Bun.build failed:
+${result.logs.map(String).join(`
+`)}`);
+  }
+  let precacheBytes = 0;
+  for (const { url } of precache) {
+    precacheBytes += (await stat(join(client, url))).size;
+  }
+  return {
+    file: out,
+    precache,
+    precacheBytes,
+    bytes: (await stat(out)).size
+  };
+}
+export { buildWorker2 };
+
+//# debugId=763F0D0F0869B4B964756E2164756E21
+//# sourceMappingURL=index-mppz0806.js.map