@qwik.dev/router 2.0.0-beta.4 → 2.0.0-beta.41

package/lib/vite/index.d.ts

@@ -7,13 +7,13 @@ import type { PluginOption } from 'vite';
 import type { SerializationStrategy } from '@qwik.dev/core/internal';
 import { UserConfigExport } from 'vite';
 
-declare interface BuildEntry extends ParsedPathname {
+declare interface BuiltEntry extends ParsedPathname {
     id: string;
     chunkFileName: string;
     filePath: string;
 }
 
-declare interface BuildLayout {
+declare interface BuiltLayout {
     filePath: string;
     dirPath: string;
     id: string;
@@ -21,7 +21,7 @@ declare interface BuildLayout {
     layoutName: string;
 }
 
-declare interface BuildRoute extends ParsedPathname {
+declare interface BuiltRoute extends ParsedPathname {
     /** Unique id built from its relative file system path */
     id: string;
     /** Local file system path */
@@ -29,7 +29,7 @@ declare interface BuildRoute extends ParsedPathname {
     ext: string;
     /** URL Pathname */
     pathname: string;
-    layouts: BuildLayout[];
+    layouts: BuiltLayout[];
 }
 
 /** @public */
@@ -81,13 +81,13 @@ declare interface PathnameSegmentPart {
 
 /** @public */
 declare interface PluginOptions {
-    /** Directory of the `routes`. Defaults to `src/routes`. */
+    /** Directory of the `routes`. Defaults to `"src/routes"`. */
     routesDir?: string;
-    /** Directory of the `server plugins`. Defaults to `src/server-plugins`. */
+    /** Directory of the `server plugins`. Defaults to `routesDir`. */
     serverPluginsDir?: string;
     /**
      * The base pathname is used to create absolute URL paths up to the `hostname`, and must always
-     * start and end with a `/`. Defaults to `/`.
+     * start and end with a `/`. Defaults to `"/""`.
      */
     basePathname?: string;
     /**
@@ -99,12 +99,33 @@ declare interface PluginOptions {
     mdxPlugins?: MdxPlugins;
     /** MDX Options https://mdxjs.com/ */
     mdx?: any;
-    /** The platform object which can be used to mock the Cloudflare bindings. */
+    /**
+     * Extend the `platform` object in RequestEvent, which can be used to e.g. mock Cloudflare
+     * bindings.
+     *
+     * This only works in **dev mode** and only when using the in-process Vite dev server middleware
+     * (the default).
+     */
     platform?: Record<string, unknown>;
     /** Configuration to rewrite url paths */
     rewriteRoutes?: RewriteRouteOption[];
     /** The serialization strategy for route loaders. Defaults to `never`. */
     defaultLoadersSerializationStrategy?: SerializationStrategy;
+    /**
+     * Enable strict mode for route loaders and actions by default.
+     *
+     * When true:
+     *
+     * - Loaders without an explicit `search` option act as if `search: []` — they only re-fetch when
+     *   the route path changes and ignore all URL search params.
+     * - Actions without an explicit `invalidate` option act as if `invalidate: []` — they don't re-run
+     *   any loaders after completion.
+     *
+     * Individual loaders/actions can override this by specifying `search` or `invalidate` explicitly.
+     *
+     * Defaults to `true`.
+     */
+    strictLoaders?: boolean;
 }
 
 /**
@@ -136,8 +157,15 @@ export declare interface QwikRouterPlugin extends P<QwikRouterPluginApi> {
 /** @public */
 declare interface QwikRouterPluginApi {
     getBasePathname: () => string;
-    getRoutes: () => BuildRoute[];
-    getServiceWorkers: () => BuildEntry[];
+    getRoutes: () => BuiltRoute[];
+    getServiceWorkers: () => BuiltEntry[];
+    /**
+     * Hand the adapter's SSG include/exclude patterns to the router so the production server route
+     * plan can drop fully-prerendered, server-free routes. Called by the SSG adapter.
+     *
+     * @internal
+     */
+    _setSsgRoutes?: (include: string[] | undefined, exclude: string[] | undefined) => void;
 }
 
 /** @public */
@@ -146,12 +174,32 @@ export declare interface QwikRouterVitePluginOptions extends Omit<PluginOptions,
     mdx?: MdxOptions;
     platform?: Record<string, unknown>;
     imageOptimization?: ImageOptimizationOptions;
+    /** Whether to use static imports for route modules (layout and index files). Defaults to `false`. */
+    staticImportRoutes?: boolean;
+    /**
+     * Qwik is an SSR first framework. This means that Qwik requires either SSR or SSG. In Vite dev
+     * mode the dev SSR server is responsible for rendering and pausing the application on the
+     * server.
+     *
+     * Under normal circumstances this should be on, unless you have your own dev SSR server setup and
+     * wish to disable this one.
+     *
+     * Default: true
+     */
+    devSsrServer?: boolean;
+    /**
+     * Maximum number of SSR-rendered pages to keep in the in-memory cache. Set to 0 to disable.
+     *
+     * Default: 50
+     */
+    ssrCacheSize?: number;
 }
 
 /** @public */
 declare interface RewriteRouteOption {
     prefix?: string;
     paths: Record<string, string>;
+    exclude?: string[];
 }
 
 export { }