@ilha/router 0.8.13 → 0.9.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.
Files changed (23) hide show
  1. package/README.md +1 -1
  2. package/dist/codegen.d.ts +3 -0
  3. package/dist/index.d.ts +28 -3
  4. package/dist/index.js +2231 -2
  5. package/dist/{plugin-DdquB3Nf.js → plugin-DPGzrIVj.js} +510 -15
  6. package/dist/plugin.d.ts +9 -1
  7. package/dist/request-scope-D6_4rqMb.js +27 -0
  8. package/dist/request-scope.d.ts +20 -0
  9. package/dist/rolldown.d.ts +1 -0
  10. package/dist/rolldown.js +2 -2
  11. package/dist/rspack.d.ts +1 -0
  12. package/dist/rspack.js +2 -2
  13. package/dist/server-island-registry.d.ts +77 -0
  14. package/dist/server-island-registry.js +130 -0
  15. package/dist/server-island.d.ts +44 -0
  16. package/dist/server-island.js +229 -0
  17. package/dist/server-islands.d.ts +72 -0
  18. package/dist/ssr.d.ts +17 -88
  19. package/dist/ssr.js +132 -130
  20. package/dist/vite.d.ts +1 -0
  21. package/dist/vite.js +2 -2
  22. package/package.json +12 -5
  23. package/dist/src-BKWkRtMx.js +0 -2119
package/README.md CHANGED
@@ -157,7 +157,7 @@ Returns a `RouterBuilder`.
157
157
 
158
158
  #### `.route(pattern, island, loader?)`
159
159
 
160
- Registers a route. Patterns are matched in **declaration order** — first match wins. Uses [rou3](https://github.com/h3js/rou3) for matching.
160
+ Registers a route. Patterns support `:param` segments and a trailing `/**:name` catch-all; static segments take priority over params, which take priority over the catch-all — regardless of registration order.
161
161
 
162
162
  The optional `loader` is a data-fetching function that runs before the page renders. Its return value is passed as input props to the island. The loader runs **wherever the router runs**: during SSR it executes on the server; when the route was registered in the browser (a plain SPA, hash mode, `file://`), client navigations execute it locally — no server or `/__ilha/loader` endpoint needed. Routes marked via `.markLoader()` (the SSR-split pages build) still fetch from the endpoint.
163
163
 
package/dist/codegen.d.ts CHANGED
@@ -1,3 +1,6 @@
1
+ /** Server pages: `foo.server.tsx` routes `/foo`, rendered through the frame protocol. */
2
+ export declare const SERVER_PAGE_RE: RegExp;
3
+ export declare function fileToPattern(pagesDir: string, file: string): string;
1
4
  export type PagesMode = "spa" | "static";
2
5
  export interface GenerateOptions {
3
6
  /** Client navigation mode. Default: `spa`. */
package/dist/index.d.ts CHANGED
@@ -71,6 +71,9 @@ export type Loader<T> = (ctx: LoaderContext) => Promise<T> | T;
71
71
  * in flight, so `useRoute().params()` inside a loader reads stale params.
72
72
  */
73
73
  export declare function loader<T>(fn: Loader<T>): Loader<T>;
74
+ export declare namespace loader {
75
+ var client: <T>(fn: Loader<T>) => Loader<T>;
76
+ }
74
77
  /** Extract the return type of a loader. */
75
78
  export type InferLoader<L> = L extends Loader<infer T> ? Awaited<T> : never;
76
79
  /**
@@ -165,7 +168,7 @@ export interface RouterOptions {
165
168
  export interface HydratableRenderOptions extends Partial<Omit<HydratableOptions, "name">> {
166
169
  /**
167
170
  * Base `<head>` data merged before loader and render-time contributions, so
168
- * route-level head overrides it. Used by host entries (e.g. `IlhaHandler`)
171
+ * route-level head overrides it. Used by host entries rendering routes server-side
169
172
  * to supply app-wide title/meta/scripts.
170
173
  */
171
174
  baseHead?: HeadInput;
@@ -222,7 +225,7 @@ export interface RouterBuilder {
222
225
  /**
223
226
  * Attach a loader that runs **in the browser** on client navigations,
224
227
  * instead of fetching from the loader endpoint. Used by the FS-routing
225
- * codegen for `clientLoad` exports; also available for manual routers.
228
+ * codegen for `loader.client` exports; also available for manual routers.
226
229
  * When a route has both, the client loader wins on client navigations and
227
230
  * the server loader runs during SSR. No-op if the pattern was never
228
231
  * registered via `.route()`.
@@ -259,7 +262,7 @@ export interface RouterBuilder {
259
262
  renderResponse(url: string | URL, registry: Record<string, Island<any, any>>, options?: HydratableRenderOptions, request?: Request): Promise<RenderResponse>;
260
263
  /**
261
264
  * Run the loader chain for a given URL without rendering. Backs the
262
- * `/__ilha/loader` endpoint that the host server handler (e.g. `IlhaHandler`)
265
+ * `/__ilha/loader` endpoint that the host server handler
263
266
  * serves as JSON for client-side navigation. Returns the raw loader result, a
264
267
  * redirect sentinel, or an error sentinel.
265
268
  */
@@ -314,6 +317,28 @@ export declare function navigating(): boolean;
314
317
  * server or when no router is mounted.
315
318
  */
316
319
  export declare function invalidate(): Promise<void>;
320
+ /**
321
+ * Context seeded for server-owned island renders. Extensible: future entries
322
+ * (route params, app middleware values) land here without moving call sites.
323
+ */
324
+ export interface IslandContext {
325
+ /**
326
+ * The `Request` seeding this render, when one exists — page SSR passes the
327
+ * incoming request; frame renders pass a synthesized POST with forwarded
328
+ * identity headers (`cookie`, `authorization`, …). Absent in unscoped
329
+ * renders (plain `toString()` in tests).
330
+ */
331
+ request?: Request;
332
+ }
333
+ /**
334
+ * The context seeding the current server-island render. Always returns an
335
+ * object — check `.request` rather than the context itself. Never throws, so
336
+ * render functions stay safe under plain `toString()` calls and in tests.
337
+ *
338
+ * Only meaningful inside `.server.tsx` render functions (page SSR or frame
339
+ * rendering); client code never has a reason to call it.
340
+ */
341
+ export declare function useContext(): IslandContext;
317
342
  export declare function useRoute(): {
318
343
  path: typeof routePath;
319
344
  params: typeof routeParams;