@vercel/build-utils 13.29.1 → 13.30.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @vercel/build-utils
 
+## 13.30.0
+
+### Minor Changes
+
+- 01e18e8: Add `hasFallback`, `htmlSize`, and `isDynamicRoute` to `Prerender`
+
+  These optional fields surface per-route PPR shell metadata in the Build Output so consumers can classify prerenders (e.g. full shell vs. empty shell vs. concrete prerender):
+
+  - `hasFallback` — whether a dynamic route template had a static fallback (`undefined` for concrete prerenders)
+  - `htmlSize` — byte size of the prerendered `.html` shell (`0` for an empty shell, `undefined` when there's no `.html`)
+  - `isDynamicRoute` — whether the entry came from a dynamic route template rather than a concrete prerender
+
 ## 13.29.1
 
 ### Patch Changes

package/dist/index.js

@@ -35560,6 +35560,13 @@ var NodejsLambda = class extends Lambda {
 };
 
 // src/prerender.ts
+function assertOptionalBoolean(value, name) {
+  if (value !== void 0 && typeof value !== "boolean") {
+    throw new Error(
+      `The \`${name}\` argument for \`Prerender\` must be a boolean or undefined.`
+    );
+  }
+}
 var Prerender = class {
   constructor({
     expiration,
@@ -35579,18 +35586,27 @@ var Prerender = class {
     chain,
     exposeErrBody,
     partialFallback,
-    hasPostponed
+    hasPostponed,
+    hasFallback,
+    htmlSize,
+    isDynamicRoute
   }) {
     this.type = "Prerender";
     this.expiration = expiration;
     this.staleExpiration = staleExpiration;
     this.sourcePath = sourcePath;
-    if (hasPostponed !== void 0 && typeof hasPostponed !== "boolean") {
+    assertOptionalBoolean(hasPostponed, "hasPostponed");
+    this.hasPostponed = hasPostponed;
+    assertOptionalBoolean(hasFallback, "hasFallback");
+    this.hasFallback = hasFallback;
+    assertOptionalBoolean(isDynamicRoute, "isDynamicRoute");
+    this.isDynamicRoute = isDynamicRoute;
+    if (htmlSize !== void 0 && (!Number.isInteger(htmlSize) || htmlSize < 0)) {
       throw new Error(
-        "The `hasPostponed` argument for `Prerender` must be a boolean or undefined."
+        "The `htmlSize` argument for `Prerender` must be a non-negative integer or undefined."
       );
     }
-    this.hasPostponed = hasPostponed;
+    this.htmlSize = htmlSize;
     this.lambda = lambda;
     if (this.lambda) {
       this.lambda.operationType = this.lambda.operationType || "ISR";

package/dist/prerender.d.ts

@@ -19,6 +19,9 @@ interface PrerenderOptions {
     exposeErrBody?: boolean;
     partialFallback?: boolean;
     hasPostponed?: boolean;
+    hasFallback?: boolean;
+    htmlSize?: number;
+    isDynamicRoute?: boolean;
 }
 export declare class Prerender {
     type: 'Prerender';
@@ -55,6 +58,25 @@ export declare class Prerender {
      * not provide the signal.
      */
     hasPostponed?: boolean;
-    constructor({ expiration, staleExpiration, lambda, fallback, group, bypassToken, allowQuery, allowHeader, initialHeaders, initialStatus, passQuery, sourcePath, experimentalBypassFor, experimentalStreamingLambdaPath, chain, exposeErrBody, partialFallback, hasPostponed, }: PrerenderOptions);
+    /**
+     * `true` when the route's dynamic template had a static fallback page (the
+     * prerender-manifest `fallback` was a string). `false` for blocking/omitted
+     * dynamic templates (manifest `fallback` was `null`/`false`). `undefined` for
+     * concrete prerenders, where the notion of a fallback doesn't apply.
+     */
+    hasFallback?: boolean;
+    /**
+     * Byte size on disk of the route's prerendered `.html` shell. `0` for an
+     * empty shell (PPR template that postponed everything). `undefined` when
+     * there's no `.html` on disk (pages router, route handlers, edge).
+     */
+    htmlSize?: number;
+    /**
+     * `true` when this entry came from a dynamic route template (the
+     * prerender-manifest `dynamicRoutes` section: fallback, blocking, or omitted)
+     * rather than a concrete prerender.
+     */
+    isDynamicRoute?: boolean;
+    constructor({ expiration, staleExpiration, lambda, fallback, group, bypassToken, allowQuery, allowHeader, initialHeaders, initialStatus, passQuery, sourcePath, experimentalBypassFor, experimentalStreamingLambdaPath, chain, exposeErrBody, partialFallback, hasPostponed, hasFallback, htmlSize, isDynamicRoute, }: PrerenderOptions);
 }
 export {};

package/dist/prerender.js

@@ -21,6 +21,13 @@ __export(prerender_exports, {
   Prerender: () => Prerender
 });
 module.exports = __toCommonJS(prerender_exports);
+function assertOptionalBoolean(value, name) {
+  if (value !== void 0 && typeof value !== "boolean") {
+    throw new Error(
+      `The \`${name}\` argument for \`Prerender\` must be a boolean or undefined.`
+    );
+  }
+}
 class Prerender {
   constructor({
     expiration,
@@ -40,18 +47,27 @@ class Prerender {
     chain,
     exposeErrBody,
     partialFallback,
-    hasPostponed
+    hasPostponed,
+    hasFallback,
+    htmlSize,
+    isDynamicRoute
   }) {
     this.type = "Prerender";
     this.expiration = expiration;
     this.staleExpiration = staleExpiration;
     this.sourcePath = sourcePath;
-    if (hasPostponed !== void 0 && typeof hasPostponed !== "boolean") {
+    assertOptionalBoolean(hasPostponed, "hasPostponed");
+    this.hasPostponed = hasPostponed;
+    assertOptionalBoolean(hasFallback, "hasFallback");
+    this.hasFallback = hasFallback;
+    assertOptionalBoolean(isDynamicRoute, "isDynamicRoute");
+    this.isDynamicRoute = isDynamicRoute;
+    if (htmlSize !== void 0 && (!Number.isInteger(htmlSize) || htmlSize < 0)) {
       throw new Error(
-        "The `hasPostponed` argument for `Prerender` must be a boolean or undefined."
+        "The `htmlSize` argument for `Prerender` must be a non-negative integer or undefined."
       );
     }
-    this.hasPostponed = hasPostponed;
+    this.htmlSize = htmlSize;
     this.lambda = lambda;
     if (this.lambda) {
       this.lambda.operationType = this.lambda.operationType || "ISR";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "13.29.1",
+  "version": "13.30.0",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",
@@ -55,8 +55,8 @@
     "vitest": "2.0.1",
     "typescript": "4.9.5",
     "yazl": "2.5.1",
-    "@vercel/routing-utils": "6.3.0",
-    "@vercel/error-utils": "2.2.0"
+    "@vercel/error-utils": "2.2.0",
+    "@vercel/routing-utils": "6.3.0"
   },
   "scripts": {
     "build": "node build.mjs",