@jay-framework/dev-server 0.25.1 → 0.25.3

package/dist/index.d.ts

@@ -186,6 +186,13 @@ interface DevServer {
     freezeStore?: FreezeStore;
     /** Public API for design board applications and CLI (DL#128) */
     service: DevServerService;
+    /**
+     * Express handler that renders the designed error page for a status (DL#218). Mount
+     * `errorPageHandler(404)` as a catch-all **after** all route registrations so unmatched paths
+     * get the branded 404 instead of Express's default. Falls back to plain text when no error page
+     * matches the status.
+     */
+    errorPageHandler: (status: number) => RequestHandler;
 }
 declare function mkDevServer(rawOptions: DevServerOptions): Promise<DevServer>;
 

package/dist/index.js

@@ -13,7 +13,7 @@ import { createRequire as createRequire$1 } from "node:module";
 import * as fs from "node:fs";
 import fs__default$1 from "node:fs";
 import { scanRoutes, createRoute, routeToExpressRoute } from "@jay-framework/stack-route-scanner";
-import { makePassthroughInstanceComponent, actionRegistry, scanPlugins, serializeHeadTags, mergeHeadTags, serializeScripts, discoverPluginsWithInit, sortPluginsByDependencies, executePluginServerInits, runInitCallbacks, runShutdownCallbacks, clearLifecycleCallbacks, clearServiceRegistry, clearClientInitData, runLoadParams, DevSlowlyChangingPhase, preparePluginClientInits, registerService, getServiceRegistry, parseCookies, renderFastChangingData, getClientInitData, slowRenderInstances, normalizeInstancePropNames } from "@jay-framework/stack-server-runtime";
+import { makePassthroughInstanceComponent, actionRegistry, scanPlugins, serializeHeadTags, mergeHeadTags, serializeScripts, discoverPluginsWithInit, sortPluginsByDependencies, executePluginServerInits, runInitCallbacks, runShutdownCallbacks, clearLifecycleCallbacks, clearServiceRegistry, clearClientInitData, runLoadParams, DevSlowlyChangingPhase, preparePluginClientInits, registerService, getServiceRegistry, parseCookies, renderFastChangingData, getClientInitData, slowRenderInstances, normalizeInstancePropNames, resolveErrorPageToken, buildErrorViewState } from "@jay-framework/stack-server-runtime";
 import * as fs$1 from "node:fs/promises";
 import fs__default from "node:fs/promises";
 import jsBeautify from "js-beautify";
@@ -4405,10 +4405,22 @@ class DevServerService {
 let _watchLinkedFiles = () => {
 };
 async function initRoutes(pagesBaseFolder) {
-  return await scanRoutes(pagesBaseFolder, {
+  const { routes } = await scanRoutes(pagesBaseFolder, {
     jayHtmlFilename: "page.jay-html",
     compFilename: "page.ts"
   });
+  return routes;
+}
+async function initErrorPages(pagesBaseFolder) {
+  const { errorPages } = await scanRoutes(pagesBaseFolder, {
+    jayHtmlFilename: "page.jay-html",
+    compFilename: "page.ts"
+  });
+  const map = /* @__PURE__ */ new Map();
+  for (const ep of errorPages) {
+    map.set(ep.token, createRoute(`/_errors/${ep.token}`, ep.jayHtmlPath, ep.compPath));
+  }
+  return map;
 }
 async function scanPluginRoutes(projectRoot, projectRoutes) {
   const plugins = await scanPlugins({ projectRoot, includeDevDeps: true });
@@ -4538,12 +4550,81 @@ function defaults(options) {
     httpServer: options.httpServer
   };
 }
-function handleOtherResponseCodes(res, renderedResult) {
-  if (renderedResult.kind === `ServerError`)
-    res.status(renderedResult.status).end("server error");
-  else if (renderedResult.kind === `ClientError`)
-    res.status(renderedResult.status).end("client error");
-  else res.status(renderedResult.status).end("redirect to " + renderedResult.location);
+let _renderDevErrorPage = async (res, info) => {
+  if (!res.headersSent)
+    res.status(info.status).type("text/plain").send(info.message || info.title || "Error");
+};
+async function renderDevErrorPage(vite, options, errorRoutes, projectInit, allPluginsWithInit, allPluginClientInits, res, info) {
+  const plainText = () => {
+    if (!res.headersSent)
+      res.status(info.status).type("text/plain").send(info.message || info.title || "Error");
+  };
+  try {
+    const token = resolveErrorPageToken(errorRoutes.keys(), info.status);
+    if (!token) return plainText();
+    const route = errorRoutes.get(token);
+    const partsResult = await loadPageParts(
+      vite,
+      route,
+      options.pagesRootFolder,
+      options.projectRootFolder,
+      options.jayRollupConfig
+    );
+    if (!partsResult.val) {
+      getLogger().warn(
+        `[DevServer] Error page "${token}" failed to load: ${partsResult.validations.join("; ")}`
+      );
+      return plainText();
+    }
+    const { parts, clientTrackByMap, usedPackages, scripts } = partsResult.val;
+    const pluginsForPage = filterPluginsForPage(
+      allPluginClientInits,
+      allPluginsWithInit,
+      usedPackages
+    );
+    const fullViewState = buildErrorViewState(info, {});
+    await sendResponse(
+      vite,
+      res,
+      info.url,
+      route.jayHtmlPath,
+      route.jayHtmlPath,
+      parts,
+      fullViewState,
+      {},
+      clientTrackByMap,
+      projectInit,
+      pluginsForPage,
+      options,
+      routeToExpressRoute(route),
+      getRouteDir(route),
+      {},
+      void 0,
+      void 0,
+      void 0,
+      scripts,
+      info.status
+    );
+  } catch (err) {
+    getLogger().error(
+      `[DevServer] Error page render failed (${info.status} ${info.url}): ${err?.message}`
+    );
+    plainText();
+  }
+}
+async function handleOtherResponseCodes(res, renderedResult, url) {
+  if (renderedResult.kind === `Redirect`) {
+    res.status(renderedResult.status).end("redirect to " + renderedResult.location);
+    return;
+  }
+  await _renderDevErrorPage(res, {
+    status: renderedResult.status,
+    url,
+    message: renderedResult.message,
+    title: renderedResult.title,
+    code: renderedResult.code,
+    details: renderedResult.details
+  });
 }
 function filterPluginsForPage(allPluginClientInits, allPluginsWithInit, usedPackages) {
   const pluginsByPackage = /* @__PURE__ */ new Map();
@@ -4671,7 +4752,12 @@ function mkRoute(route, vite, slowlyPhase, options, slowRenderCache, freezeStore
     } catch (e2) {
       vite?.ssrFixStacktrace(e2);
       getLogger().error(e2.stack);
-      res.status(500).end(e2.stack);
+      const errUrl = (req.originalUrl || req.url || "/").split("?")[0];
+      await _renderDevErrorPage(res, {
+        status: 500,
+        url: errUrl,
+        message: e2.message
+      });
       timing?.end();
     }
   };
@@ -4734,7 +4820,7 @@ async function handleCachedRequest(vite, route, options, cachedEntry, pageParams
   );
   timing?.recordFastRender(Date.now() - fastStart);
   if (renderedFast.kind !== "PhaseOutput") {
-    handleOtherResponseCodes(res, renderedFast);
+    await handleOtherResponseCodes(res, renderedFast, url);
     timing?.end();
     return;
   }
@@ -4810,7 +4896,7 @@ async function handlePreRenderRequest(vite, route, options, slowlyPhase, slowRen
   );
   if (renderedSlowly.kind !== "PhaseOutput") {
     timing?.recordSlowRender(Date.now() - slowStart);
-    handleOtherResponseCodes(res, renderedSlowly);
+    await handleOtherResponseCodes(res, renderedSlowly, url);
     timing?.end();
     return;
   }
@@ -4920,7 +5006,7 @@ async function handleClientOnlyRequest(vite, route, options, slowlyPhase, pagePa
   );
   if (renderedSlowly.kind !== "PhaseOutput") {
     timing?.recordSlowRender(Date.now() - slowStart);
-    handleOtherResponseCodes(res, renderedSlowly);
+    await handleOtherResponseCodes(res, renderedSlowly, url);
     timing?.end();
     return;
   }
@@ -4941,7 +5027,7 @@ async function handleClientOnlyRequest(vite, route, options, slowlyPhase, pagePa
   );
   timing?.recordFastRender(Date.now() - fastStart);
   if (renderedFast.kind !== "PhaseOutput") {
-    handleOtherResponseCodes(res, renderedFast);
+    await handleOtherResponseCodes(res, renderedFast, url);
     timing?.end();
     return;
   }
@@ -4985,7 +5071,7 @@ async function handleClientOnlyRequest(vite, route, options, slowlyPhase, pagePa
   res.status(200).set({ "Content-Type": "text/html" }).send(compiledPageHtml);
   timing?.end();
 }
-async function sendResponse(vite, res, url, jayHtmlPath, sourceJayHtmlPath, pageParts, viewState, carryForward, clientTrackByMap, projectInit, pluginsForPage, options, routePattern, routeDir, slowViewState, timing, preLoadedContent, headTags, scripts) {
+async function sendResponse(vite, res, url, jayHtmlPath, sourceJayHtmlPath, pageParts, viewState, carryForward, clientTrackByMap, projectInit, pluginsForPage, options, routePattern, routeDir, slowViewState, timing, preLoadedContent, headTags, scripts, statusCode = 200) {
   let pageHtml;
   try {
     const jayHtmlDir = path__default.dirname(jayHtmlPath);
@@ -5048,7 +5134,7 @@ async function sendResponse(vite, res, url, jayHtmlPath, sourceJayHtmlPath, page
   const viteStart = Date.now();
   const compiledPageHtml = await vite.transformIndexHtml(!!url ? url : "/", pageHtml);
   timing?.recordViteClient(Date.now() - viteStart);
-  res.status(200).set({ "Content-Type": "text/html" }).send(compiledPageHtml);
+  res.status(statusCode).set({ "Content-Type": "text/html" }).send(compiledPageHtml);
   timing?.end();
 }
 async function handleFrozenRequest(vite, route, options, freezeStore, slowRenderCache, freezeId, pageParams, format, res, url, timing) {
@@ -5230,6 +5316,7 @@ async function mkDevServer(rawOptions) {
   setupActionRouter(vite, buildFolder);
   const projectRoutes = await initRoutes(pagesRootFolder);
   const filteredProjectRoutes = buildFolder ? projectRoutes.filter((route) => !route.jayHtmlPath.startsWith(buildFolder)) : projectRoutes;
+  const errorRoutes = await initErrorPages(pagesRootFolder);
   const pluginRoutes = await scanPluginRoutes(projectRootFolder, filteredProjectRoutes);
   const routes = [...filteredProjectRoutes, ...pluginRoutes];
   const slowlyPhase = new DevSlowlyChangingPhase();
@@ -5243,6 +5330,16 @@ async function mkDevServer(rawOptions) {
   const projectInit = lifecycleManager.getProjectInit() ?? void 0;
   const pluginsWithInit = lifecycleManager.getPluginsWithInit();
   const pluginClientInits = preparePluginClientInits(pluginsWithInit);
+  _renderDevErrorPage = (res, info) => renderDevErrorPage(
+    vite,
+    options,
+    errorRoutes,
+    projectInit,
+    pluginsWithInit,
+    pluginClientInits,
+    res,
+    info
+  );
   const freezeStore = buildFolder ? new FreezeStore(buildFolder) : void 0;
   if (freezeStore) {
     setupFreezeEndpoint(vite, freezeStore);
@@ -5314,7 +5411,11 @@ async function mkDevServer(rawOptions) {
     routes: devServerRoutes,
     lifecycleManager,
     freezeStore,
-    service
+    service,
+    errorPageHandler: (status) => async (req, res) => {
+      const url = (req.originalUrl || req.url || "/").split("?")[0];
+      await _renderDevErrorPage(res, { status, url });
+    }
   };
 }
 function setupGracefulShutdown(lifecycleManager) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jay-framework/dev-server",
-  "version": "0.25.1",
+  "version": "0.25.3",
   "type": "module",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -23,24 +23,24 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@jay-framework/compiler-jay-stack": "^0.25.1",
-    "@jay-framework/compiler-shared": "^0.25.1",
-    "@jay-framework/component": "^0.25.1",
-    "@jay-framework/fullstack-component": "^0.25.1",
-    "@jay-framework/logger": "^0.25.1",
-    "@jay-framework/runtime": "^0.25.1",
-    "@jay-framework/stack-client-runtime": "^0.25.1",
-    "@jay-framework/stack-route-scanner": "^0.25.1",
-    "@jay-framework/stack-server-build": "^0.25.1",
-    "@jay-framework/stack-server-runtime": "^0.25.1",
-    "@jay-framework/view-state-merge": "^0.25.1",
+    "@jay-framework/compiler-jay-stack": "^0.25.3",
+    "@jay-framework/compiler-shared": "^0.25.3",
+    "@jay-framework/component": "^0.25.3",
+    "@jay-framework/fullstack-component": "^0.25.3",
+    "@jay-framework/logger": "^0.25.3",
+    "@jay-framework/runtime": "^0.25.3",
+    "@jay-framework/stack-client-runtime": "^0.25.3",
+    "@jay-framework/stack-route-scanner": "^0.25.3",
+    "@jay-framework/stack-server-build": "^0.25.3",
+    "@jay-framework/stack-server-runtime": "^0.25.3",
+    "@jay-framework/view-state-merge": "^0.25.3",
     "busboy": "^1.6.0",
     "vite": "^5.0.11"
   },
   "devDependencies": {
-    "@jay-framework/dev-environment": "^0.25.1",
-    "@jay-framework/jay-cli": "^0.25.1",
-    "@jay-framework/stack-client-runtime": "^0.25.1",
+    "@jay-framework/dev-environment": "^0.25.3",
+    "@jay-framework/jay-cli": "^0.25.3",
+    "@jay-framework/stack-client-runtime": "^0.25.3",
     "@playwright/test": "^1.58.2",
     "@types/busboy": "^1.5.4",
     "@types/express": "^5.0.2",