Merge pull request #7752 from QwikDev/fix-static

fix(router): inline staticPaths and notFounds

Author: wmertens

packages/qwik-router/global.d.ts

@@ -24,3 +24,6 @@ declare var __DEFAULT_LOADERS_SERIALIZATION_STRATEGY__: SerializationStrategy;
 
 /** Should routes not have a trailing slash? */
 declare var __NO_TRAILING_SLASH__: boolean;
+
+declare var __QWIK_BUILD_DIR__: string;
+declare var __QWIK_ASSETS_DIR__: string;

packages/qwik-router/middleware/request-handler/generated/not-found-paths.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';
 }

packages/qwik-router/middleware/request-handler/generated/static-paths.ts

@@ -18,26 +18,14 @@ export interface AdapterSSGOptions extends Omit<SsgRenderOptions, 'outDir' | 'or
 // @public (undocumented)
 export function getParentDir(startDir: string, dirName: string): string;
 
-// @public (undocumented)
-export const NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths";
-
-// @public (undocumented)
-export const RESOLVED_NOT_FOUND_PATHS_ID = "@qwik-router-not-found-paths.js";
-
-// @public (undocumented)
-export const RESOLVED_STATIC_PATHS_ID = "@qwik-router-static-paths.js";
-
 // @public (undocumented)
 export interface ServerAdapterOptions {
     ssg?: AdapterSSGOptions | null;
 }
 
-// @public (undocumented)
-export const STATIC_PATHS_ID = "@qwik-router-static-paths";
-
 // Warning: (ae-forgotten-export) The symbol "ViteAdapterPluginOptions" needs to be exported by the entry point index.d.ts
 //
-// @public (undocumented)
+// @public
 export function viteAdapter(opts: ViteAdapterPluginOptions): Plugin_2<never>;
 
 // (No @packageDocumentation comment for this package)

packages/qwik-router/modules.d.ts

@@ -1,25 +1,29 @@
 import type { QwikVitePlugin } from '@qwik.dev/core/optimizer';
 import type { StaticGenerateOptions, SsgRenderOptions } from 'packages/qwik-router/src/ssg';
 import type { QwikRouterPlugin } from '@qwik.dev/router/vite';
-import fs from 'node:fs';
 import { basename, dirname, join, resolve } from 'node:path';
 import type { Plugin, UserConfig } from 'vite';
 import type { BuildRoute } from '../../../buildtime/types';
 import { postBuild } from './post-build';
 
-/** @public */
+/**
+ * Implements the SSG after the build is complete. Also provides a `generate(...)` callback that is
+ * called after the SSG is complete, which allows for custom post-processing of the complete build
+ * results.
+ *
+ * @public
+ */
 export function viteAdapter(opts: ViteAdapterPluginOptions) {
   let qwikRouterPlugin: QwikRouterPlugin | null = null;
   let qwikVitePlugin: QwikVitePlugin | null = null;
   let serverOutDir: string | null = null;
   let renderModulePath: string | null = null;
   let qwikRouterConfigModulePath: string | null = null;
   let isSsrBuild = false;
-  let format = 'esm';
   const outputEntries: string[] = [];
 
   const plugin: Plugin<never> = {
-    name: `vite-plugin-qwik-router-${opts.name}`,
+    name: `vite-plugin-qwik-router-ssg-${opts.name}`,
     enforce: 'post',
     apply: 'build',
 
@@ -63,11 +67,6 @@ export function viteAdapter(opts: ViteAdapterPluginOptions) {
             `"build.rollupOptions.input" must be set in order to use the "${opts.name}" adapter.`
           );
         }
-
-        // @ts-ignore `format` removed in Vite 5
-        if (config.ssr?.format === 'cjs') {
-          format = 'cjs';
-        }
       }
     },
     buildStart() {
@@ -108,13 +107,7 @@ export function viteAdapter(opts: ViteAdapterPluginOptions) {
     closeBundle: {
       sequential: true,
       async handler() {
-        if (
-          isSsrBuild &&
-          opts.ssg !== null &&
-          serverOutDir &&
-          qwikRouterPlugin?.api &&
-          qwikVitePlugin?.api
-        ) {
+        if (isSsrBuild && serverOutDir && qwikRouterPlugin?.api && qwikVitePlugin?.api) {
           const staticPaths: string[] = opts.staticPaths || [];
           const routes = qwikRouterPlugin.api.getRoutes();
           const basePathname = qwikRouterPlugin.api.getBasePathname();
@@ -124,6 +117,7 @@ export function viteAdapter(opts: ViteAdapterPluginOptions) {
 
           const rootDir = qwikVitePlugin.api.getRootDir() ?? undefined;
           if (
+            opts.ssg !== null &&
             renderModulePath &&
             qwikRouterConfigModulePath &&
             clientOutDir &&
@@ -171,42 +165,36 @@ export function viteAdapter(opts: ViteAdapterPluginOptions) {
             }
 
             staticPaths.push(...staticGenerateResult.staticPaths);
+          }
 
-            const { staticPathsCode, notFoundPathsCode } = await postBuild(
-              clientPublicOutDir,
-              assetsDir ? join(basePathname, assetsDir) : basePathname,
-              staticPaths,
-              format,
-              !!opts.cleanStaticGenerated
-            );
+          await postBuild(
+            clientPublicOutDir,
+            serverOutDir,
+            assetsDir ? join(basePathname, assetsDir) : basePathname,
+            staticPaths,
+            !!opts.cleanStaticGenerated
+          );
 
-            await Promise.all([
-              fs.promises.writeFile(join(serverOutDir, RESOLVED_STATIC_PATHS_ID), staticPathsCode),
-              fs.promises.writeFile(
-                join(serverOutDir, RESOLVED_NOT_FOUND_PATHS_ID),
-                notFoundPathsCode
-              ),
-            ]);
-            if (typeof opts.generate === 'function') {
-              await opts.generate({
-                outputEntries,
-                serverOutDir,
-                clientOutDir,
-                clientPublicOutDir,
-                basePathname,
-                routes,
-                assetsDir,
-                warn: (message) => this.warn(message),
-                error: (message) => this.error(message),
-              });
-            }
-            this.warn(
-              `\n==============================================` +
-                `\nNote: Make sure that you are serving the built files with proper cache headers.` +
-                `\nSee https://qwik.dev/docs/deployments/#cache-headers for more information.` +
-                `\n==============================================`
-            );
+          if (typeof opts.generate === 'function') {
+            await opts.generate({
+              outputEntries,
+              serverOutDir,
+              clientOutDir,
+              clientPublicOutDir,
+              basePathname,
+              routes,
+              assetsDir,
+              warn: (message) => this.warn(message),
+              error: (message) => this.error(message),
+            });
           }
+
+          this.warn(
+            `\n==============================================` +
+              `\nNote: Make sure that you are serving the built files with proper cache headers.` +
+              `\nSee https://qwik.dev/docs/deployments/#cache-headers for more information.` +
+              `\n==============================================`
+          );
         }
       },
     },
@@ -288,15 +276,3 @@ export interface AdapterSSGOptions extends Omit<SsgRenderOptions, 'outDir' | 'or
    */
   origin?: string;
 }
-
-/** @public */
-export const STATIC_PATHS_ID = '@qwik-router-static-paths';
-
-/** @public */
-export const RESOLVED_STATIC_PATHS_ID = `${STATIC_PATHS_ID}.js`;
-
-/** @public */
-export const NOT_FOUND_PATHS_ID = '@qwik-router-not-found-paths';
-
-/** @public */
-export const RESOLVED_NOT_FOUND_PATHS_ID = `${NOT_FOUND_PATHS_ID}.js`;