@qwik.dev/router 2.0.0-alpha.9 → 2.0.0-beta.2

package/lib/adapters/shared/vite/index.d.ts

@@ -1,114 +1,114 @@
-import type { Plugin as Plugin_2 } from 'vite';
-import type { StaticGenerateRenderOptions } from '@qwik.dev/router/static';
-import type { UserConfig } from 'vite';
-
-/** @public */
-export declare interface AdapterSSGOptions extends Omit<StaticGenerateRenderOptions, 'outDir' | 'origin'> {
-    /** Defines routes that should be static generated. Accepts wildcard behavior. */
-    include: string[];
-    /**
-     * Defines routes that should not be static generated. Accepts wildcard behavior. `exclude` always
-     * take priority over `include`.
-     */
-    exclude?: string[];
-    /**
-     * The URL `origin`, which is a combination of the scheme (protocol) and hostname (domain). For
-     * example, `https://qwik.dev` has the protocol `https://` and domain `qwik.dev`. However, the
-     * `origin` does not include a `pathname`.
-     *
-     * The `origin` is used to provide a full URL during Static Site Generation (SSG), and to simulate
-     * a complete URL rather than just the `pathname`. For example, in order to render a correct
-     * canonical tag URL or URLs within the `sitemap.xml`, the `origin` must be provided too.
-     *
-     * If the site also starts with a pathname other than `/`, please use the `basePathname` option in
-     * the Qwik Router config options.
-     */
-    origin?: string;
-}
-
-declare interface BuildLayout {
-    filePath: string;
-    dirPath: string;
-    id: string;
-    layoutType: 'top' | 'nested';
-    layoutName: string;
-}
-
-declare interface BuildRoute extends ParsedPathname {
-    /** Unique id built from its relative file system path */
-    id: string;
-    /** Local file system path */
-    filePath: string;
-    ext: string;
-    /** URL Pathname */
-    pathname: string;
-    layouts: BuildLayout[];
-}
-
-/** @public */
-export declare function getParentDir(startDir: string, dirName: string): string;
-
-/** @public */
-export declare const NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths";
-
-declare interface ParsedPathname {
-    routeName: string;
-    pattern: RegExp;
-    paramNames: string[];
-    segments: PathnameSegment[];
-}
-
-declare type PathnameSegment = PathnameSegmentPart[];
-
-declare interface PathnameSegmentPart {
-    content: string;
-    dynamic: boolean;
-    rest: boolean;
-}
-
-/** @public */
-export declare const RESOLVED_NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths.js";
-
-/** @public */
-export declare const RESOLVED_STATIC_PATHS_ID = "@qwik-router-static-paths.js";
-
-/** @public */
-export declare interface ServerAdapterOptions {
-    /**
-     * Options the adapter should use when running Static Site Generation (SSG). Defaults the `filter`
-     * to "auto" which will attempt to automatically decides if a page can be statically generated and
-     * does not have dynamic data, or if it the page should instead be rendered on the server (SSR).
-     * Setting to `null` will prevent any pages from being statically generated.
-     */
-    ssg?: AdapterSSGOptions | null;
-}
-
-/** @public */
-export declare const STATIC_PATHS_ID = "@qwik-router-static-paths";
-
-/** @public */
-export declare function viteAdapter(opts: ViteAdapterPluginOptions): Plugin_2<never>;
-
-/** @public */
-declare interface ViteAdapterPluginOptions {
-    name: string;
-    origin: string;
-    staticPaths?: string[];
-    ssg?: AdapterSSGOptions | null;
-    cleanStaticGenerated?: boolean;
-    maxWorkers?: number;
-    config?: (config: UserConfig) => UserConfig;
-    generate?: (generateOpts: {
-        outputEntries: string[];
-        clientOutDir: string;
-        clientPublicOutDir: string;
-        serverOutDir: string;
-        basePathname: string;
-        routes: BuildRoute[];
-        assetsDir?: string;
-        warn: (message: string) => void;
-        error: (message: string) => void;
-    }) => Promise<void>;
-}
-
-export { }
+import type { Plugin as Plugin_2 } from 'vite';
+import type { StaticGenerateRenderOptions } from '@qwik.dev/router/static';
+import type { UserConfig } from 'vite';
+
+/** @public */
+export declare interface AdapterSSGOptions extends Omit<StaticGenerateRenderOptions, 'outDir' | 'origin'> {
+    /** Defines routes that should be static generated. Accepts wildcard behavior. */
+    include: string[];
+    /**
+     * Defines routes that should not be static generated. Accepts wildcard behavior. `exclude` always
+     * take priority over `include`.
+     */
+    exclude?: string[];
+    /**
+     * The URL `origin`, which is a combination of the scheme (protocol) and hostname (domain). For
+     * example, `https://qwik.dev` has the protocol `https://` and domain `qwik.dev`. However, the
+     * `origin` does not include a `pathname`.
+     *
+     * The `origin` is used to provide a full URL during Static Site Generation (SSG), and to simulate
+     * a complete URL rather than just the `pathname`. For example, in order to render a correct
+     * canonical tag URL or URLs within the `sitemap.xml`, the `origin` must be provided too.
+     *
+     * If the site also starts with a pathname other than `/`, please use the `basePathname` option in
+     * the Qwik Router config options.
+     */
+    origin?: string;
+}
+
+declare interface BuildLayout {
+    filePath: string;
+    dirPath: string;
+    id: string;
+    layoutType: 'top' | 'nested';
+    layoutName: string;
+}
+
+declare interface BuildRoute extends ParsedPathname {
+    /** Unique id built from its relative file system path */
+    id: string;
+    /** Local file system path */
+    filePath: string;
+    ext: string;
+    /** URL Pathname */
+    pathname: string;
+    layouts: BuildLayout[];
+}
+
+/** @public */
+export declare function getParentDir(startDir: string, dirName: string): string;
+
+/** @public */
+export declare const NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths";
+
+declare interface ParsedPathname {
+    routeName: string;
+    pattern: RegExp;
+    paramNames: string[];
+    segments: PathnameSegment[];
+}
+
+declare type PathnameSegment = PathnameSegmentPart[];
+
+declare interface PathnameSegmentPart {
+    content: string;
+    dynamic: boolean;
+    rest: boolean;
+}
+
+/** @public */
+export declare const RESOLVED_NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths.js";
+
+/** @public */
+export declare const RESOLVED_STATIC_PATHS_ID = "@qwik-router-static-paths.js";
+
+/** @public */
+export declare interface ServerAdapterOptions {
+    /**
+     * Options the adapter should use when running Static Site Generation (SSG). Defaults the `filter`
+     * to "auto" which will attempt to automatically decides if a page can be statically generated and
+     * does not have dynamic data, or if it the page should instead be rendered on the server (SSR).
+     * Setting to `null` will prevent any pages from being statically generated.
+     */
+    ssg?: AdapterSSGOptions | null;
+}
+
+/** @public */
+export declare const STATIC_PATHS_ID = "@qwik-router-static-paths";
+
+/** @public */
+export declare function viteAdapter(opts: ViteAdapterPluginOptions): Plugin_2<never>;
+
+/** @public */
+declare interface ViteAdapterPluginOptions {
+    name: string;
+    origin: string;
+    staticPaths?: string[];
+    ssg?: AdapterSSGOptions | null;
+    cleanStaticGenerated?: boolean;
+    maxWorkers?: number;
+    config?: (config: UserConfig) => UserConfig;
+    generate?: (generateOpts: {
+        outputEntries: string[];
+        clientOutDir: string;
+        clientPublicOutDir: string;
+        serverOutDir: string;
+        basePathname: string;
+        routes: BuildRoute[];
+        assetsDir?: string;
+        warn: (message: string) => void;
+        error: (message: string) => void;
+    }) => Promise<void>;
+}
+
+export { }

package/lib/adapters/shared/vite/index.mjs

@@ -296,6 +296,13 @@ function viteAdapter(opts) {
                 error: (message) => this.error(message)
               });
             }
+            this.warn(
+              `
+==============================================
+Note: Make sure that you are serving the built files with proper cache headers.
+See https://qwik.dev/docs/deployments/#cache-headers for more information.
+==============================================`
+            );
           }
         }
       }

package/lib/adapters/static/vite/index.cjs

@@ -28,11 +28,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/qwik-router/src/adapters/static/vite/index.ts
-var vite_exports = {};
-__export(vite_exports, {
+var index_exports = {};
+__export(index_exports, {
   staticAdapter: () => staticAdapter
 });
-module.exports = __toCommonJS(vite_exports);
+module.exports = __toCommonJS(index_exports);
 
 // packages/qwik-router/src/adapters/shared/vite/index.ts
 var import_node_fs2 = __toESM(require("node:fs"), 1);
@@ -332,6 +332,13 @@ function viteAdapter(opts) {
                 error: (message) => this.error(message)
               });
             }
+            this.warn(
+              `
+==============================================
+Note: Make sure that you are serving the built files with proper cache headers.
+See https://qwik.dev/docs/deployments/#cache-headers for more information.
+==============================================`
+            );
           }
         }
       }

package/lib/adapters/static/vite/index.d.ts

@@ -1,10 +1,10 @@
-import type { StaticGenerateRenderOptions } from '../../../static';
-
-/** @public */
-export declare function staticAdapter(opts: StaticGenerateAdapterOptions): any;
-
-/** @public */
-export declare interface StaticGenerateAdapterOptions extends Omit<StaticGenerateRenderOptions, 'outDir'> {
-}
-
-export { }
+import type { StaticGenerateRenderOptions } from '../../../static';
+
+/** @public */
+export declare function staticAdapter(opts: StaticGenerateAdapterOptions): any;
+
+/** @public */
+export declare interface StaticGenerateAdapterOptions extends Omit<StaticGenerateRenderOptions, 'outDir'> {
+}
+
+export { }

package/lib/adapters/static/vite/index.mjs

@@ -296,6 +296,13 @@ function viteAdapter(opts) {
                 error: (message) => this.error(message)
               });
             }
+            this.warn(
+              `
+==============================================
+Note: Make sure that you are serving the built files with proper cache headers.
+See https://qwik.dev/docs/deployments/#cache-headers for more information.
+==============================================`
+            );
           }
         }
       }

package/lib/adapters/vercel-edge/vite/index.cjs

@@ -28,11 +28,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/qwik-router/src/adapters/vercel-edge/vite/index.ts
-var vite_exports = {};
-__export(vite_exports, {
+var index_exports = {};
+__export(index_exports, {
   vercelEdgeAdapter: () => vercelEdgeAdapter
 });
-module.exports = __toCommonJS(vite_exports);
+module.exports = __toCommonJS(index_exports);
 var import_node_fs = __toESM(require("node:fs"), 1);
 var import_node_path = require("node:path");
 var import_vite = require("../../shared/vite/index.cjs");

package/lib/adapters/vercel-edge/vite/index.d.ts

@@ -1,45 +1,45 @@
-import { ServerAdapterOptions } from '../../shared/vite';
-import type { StaticGenerateRenderOptions } from '@qwik.dev/router/static';
-
-export { StaticGenerateRenderOptions }
-
-/** @public */
-export declare function vercelEdgeAdapter(opts?: VercelEdgeAdapterOptions): any;
-
-/** @public */
-export declare interface VercelEdgeAdapterOptions extends ServerAdapterOptions {
-    /**
-     * Determines if the build should auto-generate the `.vercel/output/config.json` config.
-     *
-     * Defaults to `true`.
-     */
-    outputConfig?: boolean;
-    /**
-     * The `entrypoint` property in the `.vc-config.json` file. Indicates the initial file where code
-     * will be executed for the Edge Function.
-     *
-     * Defaults to `entry.vercel-edge.js`.
-     */
-    vcConfigEntryPoint?: string;
-    /**
-     * The `envVarsInUse` property in the `.vc-config.json` file. List of environment variable names
-     * that will be available for the Edge Function to utilize.
-     *
-     * Defaults to `undefined`.
-     */
-    vcConfigEnvVarsInUse?: string[];
-    /**
-     * Manually add pathnames that should be treated as static paths and not SSR. For example, when
-     * these pathnames are requested, their response should come from a static file, rather than a
-     * server-side rendered response.
-     */
-    staticPaths?: string[];
-    /**
-     * Define the `target` property in the `ssr` object in the `vite.config.mts` file.
-     *
-     * Defaults to `webworker`.
-     */
-    target?: 'webworker' | 'node';
-}
-
-export { }
+import { ServerAdapterOptions } from '../../shared/vite';
+import type { StaticGenerateRenderOptions } from '@qwik.dev/router/static';
+
+export { StaticGenerateRenderOptions }
+
+/** @public */
+export declare function vercelEdgeAdapter(opts?: VercelEdgeAdapterOptions): any;
+
+/** @public */
+export declare interface VercelEdgeAdapterOptions extends ServerAdapterOptions {
+    /**
+     * Determines if the build should auto-generate the `.vercel/output/config.json` config.
+     *
+     * Defaults to `true`.
+     */
+    outputConfig?: boolean;
+    /**
+     * The `entrypoint` property in the `.vc-config.json` file. Indicates the initial file where code
+     * will be executed for the Edge Function.
+     *
+     * Defaults to `entry.vercel-edge.js`.
+     */
+    vcConfigEntryPoint?: string;
+    /**
+     * The `envVarsInUse` property in the `.vc-config.json` file. List of environment variable names
+     * that will be available for the Edge Function to utilize.
+     *
+     * Defaults to `undefined`.
+     */
+    vcConfigEnvVarsInUse?: string[];
+    /**
+     * Manually add pathnames that should be treated as static paths and not SSR. For example, when
+     * these pathnames are requested, their response should come from a static file, rather than a
+     * server-side rendered response.
+     */
+    staticPaths?: string[];
+    /**
+     * Define the `target` property in the `ssr` object in the `vite.config.mts` file.
+     *
+     * Defaults to `webworker`.
+     */
+    target?: 'webworker' | 'node';
+}
+
+export { }