sibujs 4.13.0 → 4.14.0

package/dist/build.d.cts

@@ -430,8 +430,62 @@ interface PrerenderRoute {
     output?: string;
 }
 interface PrerenderOptions {
-    /** Routes to render. */
-    routes: Array<string | PrerenderRoute>;
+    /**
+     * Routes to render. With `server`, defaults to `"auto"`: every route of the
+     * exported table without params, plus the paths `getStaticPaths()` lists
+     * for dynamic ones. A query variant (`"/cotizar?servicio=dtf"`) is rendered
+     * only when listed, and needs its own `output` file.
+     */
+    routes?: Array<string | PrerenderRoute> | "auto";
+    /**
+     * A SERVER ENTRY module (relative to the Vite root) exporting the app's
+     * `routes`, and optionally `head` (router head defaults), `routerOptions`
+     * and `app` (the shell around `Route()`). Routes are then rendered with
+     * `renderRoute()` on the built-in server DOM — the request-scoped router,
+     * async data, the collected head and transferred state — with no jsdom.
+     * Without it, the 4.13 mode runs the client entry in jsdom.
+     */
+    server?: string;
+    /** Output dir (relative to the Vite root). Default: Vite's `build.outDir`. */
+    outDir?: string;
+    /**
+     * Data at build time: a base URL that relative `fetch()` URLs (`/api/…`)
+     * resolve against (a running API), or a `fetch` implementation. A request
+     * that cannot reach it fails the build, naming the route. Default: `origin`.
+     * Server-entry mode only.
+     */
+    fetch?: string | typeof fetch;
+    /**
+     * `"always"` (default): `/cotizar` is written as `cotizar/index.html`, the
+     * sitemap lists `/cotizar/`. `"never"`: `cotizar.html`, listed as `/cotizar`
+     * (the static server must map `/cotizar` to `cotizar.html`).
+     */
+    trailingSlash?: "always" | "never";
+    /**
+     * URL rendered through the `*` route and written as `404.html` (when it
+     * answers 404). Default `"/404"` with `server`; off otherwise. `false` to skip.
+     */
+    notFound?: string | false;
+    /** Write `sitemap.xml` (pages not `noindex`, not `render: "client"`). Default `true` with `server`, `false` otherwise. */
+    sitemap?: boolean;
+    /** Write `robots.txt` pointing at the sitemap; a string adds rules (`"Disallow: /admin"`). Default `false`. */
+    robots?: boolean | string;
+    /** `"adopt"`: mark the output for `hydrate(App, root, { strategy: "adopt" })`. Server-entry mode only. */
+    hydration?: "adopt" | "replace";
+    /**
+     * CSP nonce attribute for the transfer script. Server-entry mode only.
+     *
+     * A static file carries the SAME value on every response, and a nonce that
+     * never changes protects nothing: injected markup can reuse it. Use it only
+     * as a PLACEHOLDER your server replaces with a fresh nonce per response
+     * (nginx `sub_filter`, a middleware), the same value its CSP header sends.
+     * Without such a server, allow the script by hash (`'sha256-…'`) instead.
+     */
+    nonce?: string;
+    /** Cap on each page's transferred state in bytes. Server-entry mode only. */
+    maxStateBytes?: number;
+    /** Id of the element the body renders into. Default `"app"`. Server-entry mode only. */
+    container?: string;
     /**
      * The client entry module, relative to the Vite root. Default: the first
      * `<script type="module" src>` in the source `index.html`.
@@ -471,6 +525,13 @@ interface PrerenderResult {
     route: string;
     file: string;
     ms: number;
+    /** HTTP status the route answered with (server-entry mode). */
+    status?: number;
+    /**
+     * `page` (rendered body), `shell` (head only), `redirect` (listed in
+     * redirects.json), `not-found` (404.html), `skipped` (a guard rejected it).
+     */
+    kind?: "page" | "shell" | "redirect" | "not-found" | "skipped";
 }
 /** Environment variable marking the nested SSR build, so it does not pre-render again. */
 declare const PRERENDER_CHILD_ENV = "SIBU_PRERENDER_CHILD";
@@ -484,7 +545,7 @@ declare function findEntryInHtml(html: string): string | null;
  * could escape it.
  * @internal
  */
-declare function outputFileFor(route: PrerenderRoute): string;
+declare function outputFileFor(route: PrerenderRoute, trailingSlash?: "always" | "never"): string;
 /**
  * Absolute destination of `file` inside `outDir`, refusing anything that
  * resolves outside it. The last line of defence at the write boundary, so a
@@ -752,6 +813,10 @@ declare function sibuVitePlugin(options?: SibuVitePluginOptions): {
         file: string;
         modules: unknown[];
     }) => void;
+    /** For tooling (`sibujs prerender`): the options this plugin was created with. */
+    api: {
+        prerender: PrerenderOptions | undefined;
+    };
 };
 /**
  * Generate an optimized Vite configuration for SibuJS projects.

package/dist/build.d.ts

@@ -430,8 +430,62 @@ interface PrerenderRoute {
     output?: string;
 }
 interface PrerenderOptions {
-    /** Routes to render. */
-    routes: Array<string | PrerenderRoute>;
+    /**
+     * Routes to render. With `server`, defaults to `"auto"`: every route of the
+     * exported table without params, plus the paths `getStaticPaths()` lists
+     * for dynamic ones. A query variant (`"/cotizar?servicio=dtf"`) is rendered
+     * only when listed, and needs its own `output` file.
+     */
+    routes?: Array<string | PrerenderRoute> | "auto";
+    /**
+     * A SERVER ENTRY module (relative to the Vite root) exporting the app's
+     * `routes`, and optionally `head` (router head defaults), `routerOptions`
+     * and `app` (the shell around `Route()`). Routes are then rendered with
+     * `renderRoute()` on the built-in server DOM — the request-scoped router,
+     * async data, the collected head and transferred state — with no jsdom.
+     * Without it, the 4.13 mode runs the client entry in jsdom.
+     */
+    server?: string;
+    /** Output dir (relative to the Vite root). Default: Vite's `build.outDir`. */
+    outDir?: string;
+    /**
+     * Data at build time: a base URL that relative `fetch()` URLs (`/api/…`)
+     * resolve against (a running API), or a `fetch` implementation. A request
+     * that cannot reach it fails the build, naming the route. Default: `origin`.
+     * Server-entry mode only.
+     */
+    fetch?: string | typeof fetch;
+    /**
+     * `"always"` (default): `/cotizar` is written as `cotizar/index.html`, the
+     * sitemap lists `/cotizar/`. `"never"`: `cotizar.html`, listed as `/cotizar`
+     * (the static server must map `/cotizar` to `cotizar.html`).
+     */
+    trailingSlash?: "always" | "never";
+    /**
+     * URL rendered through the `*` route and written as `404.html` (when it
+     * answers 404). Default `"/404"` with `server`; off otherwise. `false` to skip.
+     */
+    notFound?: string | false;
+    /** Write `sitemap.xml` (pages not `noindex`, not `render: "client"`). Default `true` with `server`, `false` otherwise. */
+    sitemap?: boolean;
+    /** Write `robots.txt` pointing at the sitemap; a string adds rules (`"Disallow: /admin"`). Default `false`. */
+    robots?: boolean | string;
+    /** `"adopt"`: mark the output for `hydrate(App, root, { strategy: "adopt" })`. Server-entry mode only. */
+    hydration?: "adopt" | "replace";
+    /**
+     * CSP nonce attribute for the transfer script. Server-entry mode only.
+     *
+     * A static file carries the SAME value on every response, and a nonce that
+     * never changes protects nothing: injected markup can reuse it. Use it only
+     * as a PLACEHOLDER your server replaces with a fresh nonce per response
+     * (nginx `sub_filter`, a middleware), the same value its CSP header sends.
+     * Without such a server, allow the script by hash (`'sha256-…'`) instead.
+     */
+    nonce?: string;
+    /** Cap on each page's transferred state in bytes. Server-entry mode only. */
+    maxStateBytes?: number;
+    /** Id of the element the body renders into. Default `"app"`. Server-entry mode only. */
+    container?: string;
     /**
      * The client entry module, relative to the Vite root. Default: the first
      * `<script type="module" src>` in the source `index.html`.
@@ -471,6 +525,13 @@ interface PrerenderResult {
     route: string;
     file: string;
     ms: number;
+    /** HTTP status the route answered with (server-entry mode). */
+    status?: number;
+    /**
+     * `page` (rendered body), `shell` (head only), `redirect` (listed in
+     * redirects.json), `not-found` (404.html), `skipped` (a guard rejected it).
+     */
+    kind?: "page" | "shell" | "redirect" | "not-found" | "skipped";
 }
 /** Environment variable marking the nested SSR build, so it does not pre-render again. */
 declare const PRERENDER_CHILD_ENV = "SIBU_PRERENDER_CHILD";
@@ -484,7 +545,7 @@ declare function findEntryInHtml(html: string): string | null;
  * could escape it.
  * @internal
  */
-declare function outputFileFor(route: PrerenderRoute): string;
+declare function outputFileFor(route: PrerenderRoute, trailingSlash?: "always" | "never"): string;
 /**
  * Absolute destination of `file` inside `outDir`, refusing anything that
  * resolves outside it. The last line of defence at the write boundary, so a
@@ -752,6 +813,10 @@ declare function sibuVitePlugin(options?: SibuVitePluginOptions): {
         file: string;
         modules: unknown[];
     }) => void;
+    /** For tooling (`sibujs prerender`): the options this plugin was created with. */
+    api: {
+        prerender: PrerenderOptions | undefined;
+    };
 };
 /**
  * Generate an optimized Vite configuration for SibuJS projects.

package/dist/build.js

@@ -1,28 +1,32 @@
 import {
   index_exports
-} from "./chunk-Z3EZX6DZ.js";
-import "./chunk-L3QHS4O4.js";
-import "./chunk-2F4PSJ5Z.js";
-import "./chunk-AM6DZLBM.js";
-import "./chunk-3C56VNCK.js";
-import "./chunk-G6366I2A.js";
+} from "./chunk-QS6GMWDD.js";
+import "./chunk-7ILEHTVX.js";
+import "./chunk-BOYKGGVD.js";
+import "./chunk-CNPT6NKV.js";
+import "./chunk-LJMX4SQ7.js";
+import "./chunk-RVR5NPFL.js";
+import "./chunk-CCKUNHVU.js";
+import "./chunk-3HZOSMPX.js";
 import "./chunk-62BDYGAG.js";
-import "./chunk-346BYZL2.js";
-import "./chunk-HDKDBC6V.js";
-import "./chunk-F2UWOZ6J.js";
-import "./chunk-YJ57VR6Y.js";
+import "./chunk-CJ7KS3DF.js";
+import "./chunk-HQIAL7F2.js";
+import "./chunk-RVWJGWCL.js";
+import "./chunk-N7A6FKWW.js";
 import "./chunk-7ZHH77QA.js";
-import "./chunk-BRRRVLHQ.js";
+import "./chunk-AE32RGWX.js";
 import {
   isEventHandlerAttr,
   isHtmlContentAttribute,
   isUrlAttribute
-} from "./chunk-EXXSN3BW.js";
-import "./chunk-7XHATCIH.js";
+} from "./chunk-B3HOT4TK.js";
+import "./chunk-UYTYNCMZ.js";
 import "./chunk-5HZXGZ6T.js";
-import "./chunk-GNSRXK34.js";
-import "./chunk-HVVRXRGO.js";
-import "./chunk-NYNYSPK7.js";
+import "./chunk-4FJSAUKB.js";
+import "./chunk-MIRKTVH4.js";
+import "./chunk-S37PZD6I.js";
+import "./chunk-NT3ZYB5S.js";
+import "./chunk-R5U7XKVJ.js";
 
 // src/build/analyzer.ts
 var moduleSizes = {
@@ -203,6 +207,7 @@ var SUBPATH_ENTRIES = [
   "ui",
   "widgets",
   "ssr",
+  "ssr/dom",
   "devtools",
   "performance",
   "ecosystem",
@@ -277,7 +282,7 @@ function generateImportMap(baseUrl) {
     [PACKAGE_NAME]: `${base}/dist/index.js`
   };
   for (const entry of SUBPATH_ENTRIES) {
-    imports[`${PACKAGE_NAME}/${entry}`] = `${base}/dist/${entry}.js`;
+    imports[`${PACKAGE_NAME}/${entry}`] = `${base}/dist/${entry.replace("/", "-")}.js`;
   }
   return {
     imports,
@@ -2530,7 +2535,7 @@ function findEntryInHtml(html) {
   const m = MODULE_SCRIPT.exec(html) ?? MODULE_SCRIPT_SRC_FIRST.exec(html);
   return m ? m[1] : null;
 }
-function outputFileFor(route) {
+function outputFileFor(route, trailingSlash = "always") {
   if (route.output) {
     const output = route.output;
     if (/^[A-Za-z]:/.test(output) || output.includes("\0")) {
@@ -2560,6 +2565,10 @@ function outputFileFor(route) {
     }
     return decoded;
   });
+  if (trailingSlash === "never" && segments.length > 0) {
+    const last = segments.pop();
+    return [...segments, `${last}.html`].join("/");
+  }
   return [...segments, "index.html"].join("/");
 }
 function resolveInsideOutDir(path, outDir, file) {
@@ -2575,17 +2584,36 @@ async function prerender(options, ctx) {
   const path = await import("path");
   const { pathToFileURL } = await import("url");
   const { createRequire } = await import("module");
+  const requireFromRoot = createRequire(path.join(ctx.root, "package.json"));
+  if (options.server) {
+    const { prerenderFromServerEntry } = await import("./prerenderServer-MXJEVWA3.js");
+    return prerenderFromServerEntry(options, ctx, {
+      outputFileFor,
+      resolveInsideOutDir,
+      loadViteBuild: () => loadViteBuild(requireFromRoot, fs, path, pathToFileURL),
+      childEnv: PRERENDER_CHILD_ENV
+    });
+  }
+  if (options.routes === void 0 || options.routes === "auto") {
+    throw new Error(
+      '[sibu prerender] `routes: "auto"` needs a server entry (`prerender.server`); list the routes instead.'
+    );
+  }
   const routes = options.routes.map((r) => typeof r === "string" ? { path: r } : r);
+  if (options.notFound) routes.push({ path: options.notFound, output: "404.html" });
   if (routes.length === 0) return [];
+  const trailingSlash = options.trailingSlash === "never" ? "never" : "always";
+  const outDir = options.outDir ? path.resolve(ctx.root, options.outDir) : ctx.outDir;
   const planned = routes.map((route) => {
-    const file = outputFileFor(route);
-    resolveInsideOutDir(path, ctx.outDir, file);
+    const file = outputFileFor(route, trailingSlash);
+    resolveInsideOutDir(path, outDir, file);
     return { route, file };
   });
   const origin = (options.origin ?? "http://localhost").replace(/\/+$/, "");
   const timeout = options.timeout ?? 15e3;
   const settle = options.settle ?? 50;
-  const templatePath = path.join(ctx.outDir, "index.html");
+  const keptShell = path.join(ctx.outDir, typeof options.shell === "string" ? options.shell : "200.html");
+  const templatePath = await fs.access(keptShell).then(() => keptShell).catch(() => path.join(ctx.outDir, "index.html"));
   const template = await fs.readFile(templatePath, "utf8");
   let entry = options.entry;
   if (!entry) {
@@ -2603,7 +2631,7 @@ async function prerender(options, ctx) {
   } catch {
     throw new Error("[sibu prerender] needs jsdom to render routes. Install it: npm i -D jsdom");
   }
-  const tmpDir = path.join(ctx.outDir, ".sibu-prerender");
+  const tmpDir = path.join(outDir, ".sibu-prerender");
   await fs.rm(tmpDir, { recursive: true, force: true });
   const viteBuild = await loadViteBuild(requireFromApp, fs, path, pathToFileURL);
   const prev = process.env[PRERENDER_CHILD_ENV];
@@ -2633,10 +2661,12 @@ async function prerender(options, ctx) {
   await fs.writeFile(workerFile, WORKER_SOURCE, "utf8");
   const entryUrl = pathToFileURL(path.join(tmpDir, "entry.mjs")).href;
   const jsdomUrl = pathToFileURL(jsdomPath).href;
+  await fs.mkdir(outDir, { recursive: true });
   if (options.shell !== false) {
-    await fs.writeFile(path.join(ctx.outDir, options.shell ?? "200.html"), template, "utf8");
+    await fs.writeFile(path.join(outDir, options.shell ?? "200.html"), template, "utf8");
   }
   const results = [];
+  const indexable = [];
   const queue = [...planned];
   const concurrency = Math.max(1, options.concurrency ?? 4);
   try {
@@ -2654,16 +2684,35 @@ async function prerender(options, ctx) {
             timeout,
             settle
           });
-          const target = resolveInsideOutDir(path, ctx.outDir, file);
+          const target = resolveInsideOutDir(path, outDir, file);
           await fs.mkdir(path.dirname(target), { recursive: true });
           await fs.writeFile(target, html, "utf8");
           results.push({ route: route.path, file, ms: Date.now() - started });
+          if (file !== "404.html" && !/<meta\b[^>]*name=["']robots["'][^>]*content=["'][^"']*noindex/i.test(html)) {
+            const pathname = route.path.split(/[?#]/)[0];
+            indexable.push(
+              trailingSlash === "always" && pathname !== "/" ? `${pathname.replace(/\/+$/, "")}/` : pathname
+            );
+          }
         }
       })
     );
   } finally {
     await fs.rm(tmpDir, { recursive: true, force: true });
   }
+  if (options.sitemap && indexable.length > 0) {
+    const { buildSitemap } = await import("./prerenderServer-MXJEVWA3.js");
+    await fs.writeFile(path.join(outDir, "sitemap.xml"), buildSitemap(origin, indexable.sort()), "utf8");
+  }
+  if (options.robots) {
+    const extra = typeof options.robots === "string" ? `${options.robots.trim()}
+` : "";
+    const sitemapLine = options.sitemap && indexable.length > 0 ? `Sitemap: ${origin}/sitemap.xml
+` : "";
+    await fs.writeFile(path.join(outDir, "robots.txt"), `User-agent: *
+Allow: /
+${extra}${sitemapLine}`, "utf8");
+  }
   return results;
 }
 function esmEntryOf(entry) {
@@ -2698,6 +2747,7 @@ async function loadViteBuild(requireFromApp, fs, path, pathToFileURL) {
   }
   return build;
 }
+var STARTUP_TIMEOUT = 6e4;
 async function renderInWorker(workerFile, input) {
   const { Worker } = await import("worker_threads");
   return new Promise((resolve, reject) => {
@@ -2709,12 +2759,14 @@ async function renderInWorker(workerFile, input) {
       fn();
       void worker.terminate();
     };
-    const timer = setTimeout(
-      () => finish(() => reject(new Error(`[sibu prerender] ${input.route}: worker did not respond`))),
-      input.timeout + 5e3
-    );
-    worker.once("message", (msg) => {
+    const backstop = (ms, what) => setTimeout(() => finish(() => reject(new Error(`[sibu prerender] ${input.route}: ${what}`))), ms);
+    let timer = backstop(Math.max(STARTUP_TIMEOUT, input.timeout + 5e3), "worker did not load the app");
+    worker.on("message", (msg) => {
       clearTimeout(timer);
+      if (msg.loaded) {
+        timer = backstop(input.timeout + 5e3, "worker did not respond");
+        return;
+      }
       if (typeof msg.html === "string") finish(() => resolve(msg.html));
       else finish(() => reject(new Error(`[sibu prerender] ${input.route}: ${msg.error}`)));
     });
@@ -2827,6 +2879,8 @@ try {
   process.on("unhandledRejection", (reason) => errors.push(reason));
 
   await import(entryUrl);
+  // The route's timeout starts now; the parent's backstop restarts with it.
+  parentPort.postMessage({ loaded: true });
 
   const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
   const started = Date.now();
@@ -3233,6 +3287,7 @@ function sibuVitePlugin(options = {}) {
   return {
     name: "sibu-vite-plugin",
     enforce: "pre",
+    api: { prerender: prerenderOptions },
     config(_userConfig, env) {
       isDevMode = resolveDevMode(devMode, env);
       return {
@@ -3273,7 +3328,10 @@ function sibuVitePlugin(options = {}) {
       const target = prerenderTarget;
       prerenderTarget = null;
       const results = await prerender(prerenderOptions, target);
-      for (const r of results) console.log(`[sibu prerender] ${r.route} \u2192 ${r.file} (${r.ms} ms)`);
+      for (const r of results) {
+        const what = r.kind === "redirect" ? `redirect ${r.status} (redirects.json)` : r.kind === "skipped" ? `skipped (${r.status})` : r.file;
+        console.log(`[sibu prerender] ${r.route} \u2192 ${what} (${r.ms} ms)`);
+      }
     },
     transform(code, id) {
       if (!matchesPattern(id, include) || matchesPattern(id, exclude)) {