@qwik.dev/router 2.0.0-beta.2 → 2.0.0-beta.21

package/lib/middleware/vercel-edge/index.mjs

@@ -1,27 +1,17 @@
-// packages/qwik-router/src/middleware/vercel-edge/index.ts
-import { getNotFound } from "@qwik-router-not-found-paths";
-import { isStaticPath } from "@qwik-router-static-paths";
-import { _deserialize, _serialize, _verifySerializable } from "@qwik.dev/core/internal";
-import { setServerPlatform } from "@qwik.dev/core/server";
-import { mergeHeadersCookies, requestHandler } from "../request-handler/index.mjs";
-var COUNTRY_HEADER_NAME = "x-vercel-ip-country";
-var IP_HEADER_NAME = "x-real-ip";
-var VERCEL_COOKIE = "__vdpl";
-var VERCEL_SKEW_PROTECTION_ENABLED = "VERCEL_SKEW_PROTECTION_ENABLED";
-var VERCEL_DEPLOYMENT_ID = "VERCEL_DEPLOYMENT_ID";
-var BASE_URL = "BASE_URL";
+import { setServerPlatform } from '@qwik.dev/core/server';
+import { isStaticPath, mergeHeadersCookies, requestHandler, getNotFound } from '@qwik.dev/router/middleware/request-handler';
+
+const COUNTRY_HEADER_NAME = "x-vercel-ip-country";
+const IP_HEADER_NAME = "x-real-ip";
+const VERCEL_COOKIE = "__vdpl";
+const VERCEL_SKEW_PROTECTION_ENABLED = "VERCEL_SKEW_PROTECTION_ENABLED";
+const VERCEL_DEPLOYMENT_ID = "VERCEL_DEPLOYMENT_ID";
+const BASE_URL = "BASE_URL";
 function createQwikRouter(opts) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn("qwikCityPlan is deprecated. Use qwikRouterConfig instead.");
+    console.warn("qwikCityPlan is deprecated. Simply remove it.");
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error("qwikRouterConfig is required.");
   }
-  const qwikSerializer = {
-    _deserialize,
-    _serialize,
-    _verifySerializable
-  };
   if (opts.manifest) {
     setServerPlatform(opts.manifest);
   }
@@ -75,7 +65,7 @@ function createQwikRouter(opts) {
           };
         }
       };
-      const handledResponse = await requestHandler(serverRequestEv, opts, qwikSerializer);
+      const handledResponse = await requestHandler(serverRequestEv, opts);
       if (handledResponse) {
         handledResponse.completion.then((v) => {
           if (v) {
@@ -87,7 +77,7 @@ function createQwikRouter(opts) {
           return response;
         }
       }
-      const notFoundHtml = isStaticPath(request.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
+      const notFoundHtml = !request.headers.get("accept")?.includes("text/html") || isStaticPath(request.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
       return new Response(notFoundHtml, {
         status: 404,
         headers: { "Content-Type": "text/html; charset=utf-8", "X-Not-Found": url.pathname }
@@ -102,8 +92,6 @@ function createQwikRouter(opts) {
   }
   return onVercelEdgeRequest;
 }
-var createQwikCity = createQwikRouter;
-export {
-  createQwikCity,
-  createQwikRouter
-};
+const createQwikCity = createQwikRouter;
+
+export { createQwikCity, createQwikRouter };

package/lib/modules.d.ts

@@ -19,20 +19,12 @@ declare module '@qwik-city-plan' {
   export { default } from '@qwik-router-config';
 }
 
-declare module '@qwik-router-not-found-paths' {
-  function getNotFound(_pathname: string): string;
-  export { getNotFound };
-}
-
 declare module '@qwik-city-not-found-paths' {
-  export * from '@qwik-router-not-found-paths';
-}
-
-declare module '@qwik-router-static-paths' {
-  function isStaticPath(method: string, url: URL): boolean;
-  export { isStaticPath };
+  /** @deprecated Use `getNotFound` from `@qwik.dev/router/middleware/request-handler` instead. */
+  export { getNotFound } from '@qwik.dev/router/middleware/request-handler';
 }
 
 declare module '@qwik-city-static-paths' {
-  export * from '@qwik-router-static-paths';
+  /** @deprecated Use `isStaticPath` from `@qwik.dev/router/middleware/request-handler` instead. */
+  export { isStaticPath } from '@qwik.dev/router/middleware/request-handler';
 }

package/lib/service-worker/index.mjs

@@ -0,0 +1,4 @@
+const setupServiceWorker = () => {
+};
+
+export { setupServiceWorker };

package/lib/{static → ssg}/index.d.ts

@@ -9,23 +9,7 @@ import type { RenderOptions } from '@qwik.dev/core/server';
 export declare function generate(opts: StaticGenerateOptions): Promise<StaticGenerateResult>;
 
 /** @public */
-export declare interface StaticGenerateOptions extends StaticGenerateRenderOptions {
-    /**
-     * Path to the SSR module exporting the default render function. In most cases it'll be
-     * `./src/entry.ssr.tsx`.
-     */
-    renderModulePath: string;
-    /** Path to the Qwik Router Config module exporting the default `@qwik-router-config`. */
-    qwikRouterConfigModulePath: string;
-    /** @deprecated Use `qwikRouterConfigModulePath` instead. Will be removed in V3 */
-    qwikCityPlanModulePath?: string;
-    /** Defaults to `/` */
-    basePathname?: string;
-    rootDir?: string;
-}
-
-/** @public */
-export declare interface StaticGenerateRenderOptions extends RenderOptions {
+export declare interface SsgRenderOptions extends RenderOptions {
     /** File system directory where the static files should be written. */
     outDir: string;
     /**
@@ -85,6 +69,22 @@ export declare interface StaticGenerateRenderOptions extends RenderOptions {
     exclude?: string[];
 }
 
+/** @public */
+export declare interface StaticGenerateOptions extends SsgRenderOptions {
+    /**
+     * Path to the SSR module exporting the default render function. In most cases it'll be
+     * `./src/entry.ssr.tsx`.
+     */
+    renderModulePath: string;
+    /** Path to the Qwik Router Config module exporting the default `@qwik-router-config`. */
+    qwikRouterConfigModulePath: string;
+    /** @deprecated Use `qwikRouterConfigModulePath` instead. Will be removed in V3 */
+    qwikCityPlanModulePath?: string;
+    /** Defaults to `/` */
+    basePathname?: string;
+    rootDir?: string;
+}
+
 /** @public */
 export declare interface StaticGenerateResult {
     duration: number;

package/lib/ssg/index.mjs

@@ -0,0 +1,14 @@
+async function generate(opts) {
+  const ssgPlatform = await getEntryModule();
+  const result = await ssgPlatform.generate(opts);
+  return result;
+}
+async function getEntryModule() {
+  try {
+    return await import('../chunks/index.mjs');
+  } catch (e) {
+    throw new Error(`Unsupported platform`, { cause: e });
+  }
+}
+
+export { generate };

package/lib/vite/index.d.ts

@@ -4,15 +4,16 @@ import type { Config } from 'svgo';
 import { ConfigEnv } from 'vite';
 import type { Plugin as Plugin_2 } from 'vite';
 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;
@@ -20,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 */
@@ -28,7 +29,7 @@ declare interface BuildRoute extends ParsedPathname {
     ext: string;
     /** URL Pathname */
     pathname: string;
-    layouts: BuildLayout[];
+    layouts: BuiltLayout[];
 }
 
 /** @public */
@@ -80,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;
     /**
@@ -98,10 +99,18 @@ 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;
 }
 
 /**
@@ -133,8 +142,8 @@ export declare interface QwikRouterPlugin extends P<QwikRouterPluginApi> {
 /** @public */
 declare interface QwikRouterPluginApi {
     getBasePathname: () => string;
-    getRoutes: () => BuildRoute[];
-    getServiceWorkers: () => BuildEntry[];
+    getRoutes: () => BuiltRoute[];
+    getServiceWorkers: () => BuiltEntry[];
 }
 
 /** @public */
@@ -143,6 +152,19 @@ 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;
 }
 
 /** @public */