vinext 1.0.0-beta.9 → 1.0.1

package/dist/server/pages-execution-tracing.js

@@ -0,0 +1,80 @@
+import { patternToNextFormat } from "../routing/route-validation.js";
+import { frameworkTracer } from "./tracer.js";
+import { deferUntilStreamConsumed } from "./defer-until-stream-consumed.js";
+//#region src/server/pages-execution-tracing.ts
+function createPagesDataSpanDescriptor(method, routePattern) {
+	const route = patternToNextFormat(routePattern);
+	return {
+		attributes: { "next.route": route },
+		name: `${method} ${route}`,
+		type: `Render.${method}`
+	};
+}
+function tracePagesData(method, routePattern, callback) {
+	return frameworkTracer.trace(createPagesDataSpanDescriptor(method, routePattern), callback);
+}
+function createPagesDocumentSpanDescriptor(routePattern) {
+	const route = patternToNextFormat(routePattern);
+	return {
+		attributes: { "next.route": route },
+		name: `render route (pages) ${route}`,
+		type: "Render.renderDocument"
+	};
+}
+function tracePagesDocument(routePattern, callback) {
+	return frameworkTracer.trace(createPagesDocumentSpanDescriptor(routePattern), callback);
+}
+/** Return at shell readiness while keeping the span open through body rendering. */
+function tracePagesDocumentStream(routePattern, callback) {
+	return new Promise((resolve, reject) => {
+		tracePagesDocument(routePattern, async () => {
+			try {
+				let result = await callback();
+				if (!result.waitForBody || !result.bodyStream) {
+					resolve(result);
+					return result;
+				}
+				let finish;
+				let fail;
+				const completion = new Promise((resolveCompletion, rejectCompletion) => {
+					finish = resolveCompletion;
+					fail = rejectCompletion;
+				});
+				result = {
+					...result,
+					bodyStream: deferUntilStreamConsumed(result.bodyStream, finish, fail)
+				};
+				resolve(result);
+				await completion;
+				return result;
+			} catch (error) {
+				reject(error);
+				throw error;
+			}
+		}).catch(() => {});
+	});
+}
+function createPagesApiHandlerSpanDescriptor(routePattern) {
+	return {
+		name: `executing api route (pages) ${patternToNextFormat(routePattern)}`,
+		type: "Node.runHandler"
+	};
+}
+function tracePagesApiHandler(routePattern, callback, options = {}) {
+	return frameworkTracer.trace({
+		...createPagesApiHandlerSpanDescriptor(routePattern),
+		recordErrors: options.recordErrors
+	}, callback);
+}
+function createFindPageComponentsSpanDescriptor(routePattern) {
+	return {
+		attributes: { "next.route": patternToNextFormat(routePattern) },
+		name: "resolve page components",
+		type: "NextNodeServer.findPageComponents"
+	};
+}
+function traceFindPageComponents(routePattern, callback) {
+	return frameworkTracer.trace(createFindPageComponentsSpanDescriptor(routePattern), callback);
+}
+//#endregion
+export { createFindPageComponentsSpanDescriptor, createPagesApiHandlerSpanDescriptor, createPagesDataSpanDescriptor, createPagesDocumentSpanDescriptor, traceFindPageComponents, tracePagesApiHandler, tracePagesData, tracePagesDocument, tracePagesDocumentStream };

package/dist/server/pages-get-initial-props.d.ts

@@ -11,7 +11,7 @@ type PagesGetInitialPropsContext = {
   locales?: string[];
   defaultLocale?: string;
 } & Record<string, unknown>;
-type PagesGetInitialPropsRouter = Omit<Pick<NextRouter, "route" | "pathname" | "query" | "asPath">, "query"> & {
+export type PagesGetInitialPropsRouter = Omit<Pick<NextRouter, "route" | "pathname" | "query" | "asPath">, "query"> & {
   query: Record<string, unknown>;
 };
 /**
@@ -20,10 +20,10 @@ type PagesGetInitialPropsRouter = Omit<Pick<NextRouter, "route" | "pathname" | "
  * instance; this fallback keeps direct helper callers and tests aligned with
  * the same required fields.
  */
-declare function createPagesGetInitialPropsRouter(pathname: string, query: Record<string, unknown>, asPath: string): PagesGetInitialPropsRouter;
-declare function hasPagesGetInitialProps(component: unknown): boolean;
-declare function isResponseSent(res: unknown): boolean;
-declare function loadPagesGetInitialProps(component: unknown, context: PagesGetInitialPropsContext): Promise<Record<string, unknown> | null>;
+export declare function createPagesGetInitialPropsRouter(pathname: string, query: Record<string, unknown>, asPath: string): PagesGetInitialPropsRouter;
+export declare function hasPagesGetInitialProps(component: unknown): boolean;
+export declare function isResponseSent(res: unknown): boolean;
+export declare function loadPagesGetInitialProps(component: unknown, context: PagesGetInitialPropsContext): Promise<Record<string, unknown> | null>;
 /**
  * Decision returned by {@link loadDevAppInitialProps}.
  *
@@ -34,7 +34,7 @@ declare function loadPagesGetInitialProps(component: unknown, context: PagesGetI
  * - `render`: the caller should render with the returned `pageProps` /
  *   `renderProps`.
  */
-type DevAppInitialPropsResult = {
+export type DevAppInitialPropsResult = {
   kind: "skip";
 } | {
   kind: "response-sent";
@@ -45,7 +45,7 @@ type DevAppInitialPropsResult = {
     pageProps?: unknown;
   };
 };
-type DevAppInitialPropsContext = {
+export type DevAppInitialPropsContext = {
   appComponent: unknown;
   /**
    * Builds the `AppTree` element passed to `getInitialProps`. Injected so this
@@ -75,6 +75,5 @@ type DevAppInitialPropsContext = {
  * ISR cache HIT/STALE that serves cached HTML verbatim — so userland `App`
  * data code does not run on the cache hot path.
  */
-declare function loadDevAppInitialProps(ctx: DevAppInitialPropsContext): Promise<DevAppInitialPropsResult>;
-//#endregion
-export { DevAppInitialPropsContext, DevAppInitialPropsResult, PagesGetInitialPropsRouter, createPagesGetInitialPropsRouter, hasPagesGetInitialProps, isResponseSent, loadDevAppInitialProps, loadPagesGetInitialProps };
+export declare function loadDevAppInitialProps(ctx: DevAppInitialPropsContext): Promise<DevAppInitialPropsResult>;
+//#endregion

package/dist/server/pages-i18n.d.ts

@@ -55,7 +55,7 @@ type PagesI18nRequestInfo = {
  * Ported from Next.js: packages/next/src/server/lib/router-utils/resolve-routes.ts
  * https://github.com/vercel/next.js/blob/canary/packages/next/src/server/lib/router-utils/resolve-routes.ts
  */
-declare function normalizeDefaultLocalePathname(pathname: string, i18n: NextI18nConfig | null | undefined, options?: {
+export declare function normalizeDefaultLocalePathname(pathname: string, i18n: NextI18nConfig | null | undefined, options?: {
   hostname?: string | null;
 }): string;
 /**
@@ -63,7 +63,7 @@ declare function normalizeDefaultLocalePathname(pathname: string, i18n: NextI18n
  * e.g. /fr/about -> { locale: "fr", url: "/about", hadPrefix: true }
  *      /about    -> { locale: defaultLocale, url: "/about", hadPrefix: false }
  */
-declare function extractLocaleFromUrl(url: string, i18nConfig: NextI18nConfig, defaultLocale?: string): {
+export declare function extractLocaleFromUrl(url: string, i18nConfig: NextI18nConfig, defaultLocale?: string): {
   locale: string;
   url: string;
   hadPrefix: boolean;
@@ -83,18 +83,18 @@ declare function extractLocaleFromUrl(url: string, i18nConfig: NextI18nConfig, d
  *
  * Reference: packages/next/src/shared/lib/i18n/normalize-locale-path.ts.
  */
-declare function stripI18nLocaleForApiRoute(url: string, i18nConfig: NextI18nConfig | null | undefined): string;
+export declare function stripI18nLocaleForApiRoute(url: string, i18nConfig: NextI18nConfig | null | undefined): string;
 /**
  * Detect the preferred locale from the Accept-Language header.
  * Returns the best matching locale or null.
  */
-declare function detectLocaleFromAcceptLanguage(acceptLang: string | null | undefined, i18nConfig: NextI18nConfig): string | null;
+export declare function detectLocaleFromAcceptLanguage(acceptLang: string | null | undefined, i18nConfig: NextI18nConfig): string | null;
 /**
  * Parse the NEXT_LOCALE cookie.
  * Returns the cookie value if it matches a configured locale, otherwise null.
  */
-declare function parseCookieLocaleFromHeader(cookieHeader: string | null | undefined, i18nConfig: NextI18nConfig): string | null;
-declare function getLocaleRedirect({ headers, nextConfig, pathLocale, urlParsed }: LocaleRedirectOptions): string | undefined;
-declare function resolvePagesI18nRequest(url: string, i18nConfig: NextI18nConfig, headers?: HeaderBag, hostname?: string | null, basePath?: string, trailingSlash?: boolean): PagesI18nRequestInfo;
+export declare function parseCookieLocaleFromHeader(cookieHeader: string | null | undefined, i18nConfig: NextI18nConfig): string | null;
+export declare function getLocaleRedirect({ headers, nextConfig, pathLocale, urlParsed }: LocaleRedirectOptions): string | undefined;
+export declare function resolvePagesI18nRequest(url: string, i18nConfig: NextI18nConfig, headers?: HeaderBag, hostname?: string | null, basePath?: string, trailingSlash?: boolean): PagesI18nRequestInfo;
 //#endregion
-export { detectDomainLocale, detectLocaleFromAcceptLanguage, extractLocaleFromUrl, getLocaleRedirect, normalizeDefaultLocalePathname, parseCookieLocaleFromHeader, resolvePagesI18nRequest, stripI18nLocaleForApiRoute };
+export { detectDomainLocale };

package/dist/server/pages-media-type.d.ts

@@ -5,11 +5,10 @@
  * Used by both api-handler.ts (Pages Router dev/prod with Node.js req/res) and
  * pages-node-compat.ts (Pages Router fetch-based facade for Cloudflare Workers).
  */
-declare class PagesBodyParseError extends Error {
+export declare class PagesBodyParseError extends Error {
   readonly statusCode: number;
   constructor(message: string, statusCode: number);
 }
-declare function getMediaType(contentType: string | null | undefined): string;
-declare function isJsonMediaType(mediaType: string): boolean;
-//#endregion
-export { PagesBodyParseError, getMediaType, isJsonMediaType };
+export declare function getMediaType(contentType: string | null | undefined): string;
+export declare function isJsonMediaType(mediaType: string): boolean;
+//#endregion

package/dist/server/pages-node-compat.d.ts

@@ -3,8 +3,8 @@ import { RevalidateOptions } from "./pages-revalidate.js";
 import { PagesPreviewData } from "./pages-preview.js";
 import { Readable, Writable } from "node:stream";
 //#region src/server/pages-node-compat.d.ts
-type PagesRequestQuery = Record<string, string | string[]>;
-type PagesReqResRequest = Readable & {
+export type PagesRequestQuery = Record<string, string | string[]>;
+export type PagesReqResRequest = Readable & {
   method: string;
   url: string;
   headers: Record<string, string>;
@@ -18,7 +18,7 @@ type PagesReqResRequest = Readable & {
 type PagesReqResHeaders = {
   [key: string]: string | number | boolean | string[];
 };
-type PagesReqResResponse = Writable & {
+export type PagesReqResResponse = Writable & {
   statusCode: number;
   readonly headersSent: boolean;
   writeHead: (code: number, headers?: PagesReqResHeaders) => PagesReqResResponse;
@@ -50,6 +50,7 @@ type PagesRequestCookiesCarrier = {
 type CreatePagesReqResOptions = {
   allowedRevalidateHeaderKeys?: readonly string[];
   body: unknown;
+  initialResponseHeaders?: Headers;
   query: PagesRequestQuery;
   request: Request;
   trustedRevalidateOrigin?: string;
@@ -70,9 +71,9 @@ type CreatePagesReqResResult = {
  *
  * @see https://nextjs.org/docs/pages/building-your-application/routing/api-routes#custom-config
  */
-declare function parsePagesApiBody(request: Request, maxBytes?: number): Promise<unknown>;
-declare function attachPagesRequestCookies(req: PagesRequestCookiesCarrier): void;
-declare function attachPagesPreviewApi(req: PagesReqResRequest, res: PagesReqResResponse): void;
+export declare function parsePagesApiBody(request: Request, maxBytes?: number): Promise<unknown>;
+export declare function attachPagesRequestCookies(req: PagesRequestCookiesCarrier): void;
+export declare function attachPagesPreviewApi(req: PagesReqResRequest, res: PagesReqResResponse): void;
 /**
  * Marks a Pages API Response whose body was still being written when the
  * handler settled (streaming/piping), so Node adapters forward it as a stream.
@@ -81,8 +82,8 @@ declare function attachPagesPreviewApi(req: PagesReqResRequest, res: PagesReqRes
  * `res.end(data)`) are not marked and keep the buffered path, which preserves
  * Content-Length.
  */
-declare function markVinextStreamedApiResponse(response: Response): void;
-declare function isVinextStreamedApiResponse(response: Response): boolean;
-declare function createPagesReqRes(options: CreatePagesReqResOptions): CreatePagesReqResResult;
+export declare function markVinextStreamedApiResponse(response: Response): void;
+export declare function isVinextStreamedApiResponse(response: Response): boolean;
+export declare function createPagesReqRes(options: CreatePagesReqResOptions): CreatePagesReqResResult;
 //#endregion
-export { PagesBodyParseError as PagesApiBodyParseError, PagesReqResRequest, PagesReqResResponse, PagesRequestQuery, attachPagesPreviewApi, attachPagesRequestCookies, createPagesReqRes, isVinextStreamedApiResponse, markVinextStreamedApiResponse, parsePagesApiBody };
+export { PagesBodyParseError as PagesApiBodyParseError };

package/dist/server/pages-node-compat.js

@@ -246,10 +246,12 @@ var PagesResponseStream = class extends Writable {
 	_destroy(error, callback) {
 		this.streamEnded = true;
 		this.releasePendingWrite(error);
-		if (!this.resolved) if (error) {
-			this.resolved = true;
-			this.rejectResponse(error);
-		} else this.resolveOnce();
+		if (!this.resolved) {
+			if (error) {
+				this.resolved = true;
+				this.rejectResponse(error);
+			} else this.resolveOnce();
+		}
 		if (this.controller) try {
 			if (error) this.controller.error(error);
 			else this.controller.close();
@@ -345,6 +347,12 @@ function createPagesReqRes(options) {
 		rejectResponse = reject;
 	});
 	const res = new PagesResponseStream(resolveResponse, rejectResponse, options.request.headers, options.trustedRevalidateOrigin ?? new URL(options.request.url).origin, options.allowedRevalidateHeaderKeys);
+	for (const [name, value] of options.initialResponseHeaders ?? []) {
+		if (name.toLowerCase() === "set-cookie") continue;
+		res.setHeader(name, value);
+	}
+	const initialCookies = options.initialResponseHeaders?.getSetCookie() ?? [];
+	if (initialCookies.length > 0) res.setHeader("Set-Cookie", initialCookies);
 	attachPagesPreviewApi(req, res);
 	return {
 		req,

package/dist/server/pages-page-data.d.ts

@@ -7,18 +7,18 @@ import { PagesGetInitialPropsRouter } from "./pages-get-initial-props.js";
 import { PagesGsspResponse, PagesI18nRenderContext, PagesNextDataExtras } from "./pages-page-response.js";
 import { ReactNode } from "react";
 //#region src/server/pages-page-data.d.ts
-type PagesRedirectResult = {
+export type PagesRedirectResult = {
   destination: string;
   permanent?: boolean;
   statusCode?: number;
   basePath?: boolean;
 };
-type ResolvedPagesRedirect = {
+export type ResolvedPagesRedirect = {
   destination: string;
   statusCode: number;
   basePath?: boolean;
 };
-type PagesStaticPathsEntry = string | {
+export type PagesStaticPathsEntry = string | {
   params?: Record<string, unknown>;
   locale?: string;
 };
@@ -32,7 +32,7 @@ type PagesPagePropsResult = {
   notFound?: boolean;
   revalidate?: unknown;
 };
-declare function assertPages404DoesNotReturnNotFound(routePattern: string, result: Pick<PagesPagePropsResult, "notFound"> | null | undefined): void;
+export declare function assertPages404DoesNotReturnNotFound(routePattern: string, result: Pick<PagesPagePropsResult, "notFound"> | null | undefined): void;
 /**
  * Next.js preserves an omitted/false Pages `revalidate` result as an indefinite
  * cache lifetime. The one-year sentinel is only an HTTP Cache-Control detail;
@@ -43,7 +43,7 @@ declare function assertPages404DoesNotReturnNotFound(routePattern: string, resul
  * - packages/next/src/server/render.tsx (`metadata.cacheControl`)
  * - packages/next/src/server/route-modules/pages/pages-handler.ts
  */
-declare function resolvePagesRevalidateSeconds(result: PagesPagePropsResult, routeUrl?: string): number | false;
+export declare function resolvePagesRevalidateSeconds(result: PagesPagePropsResult, routeUrl?: string): number | false;
 type PagesMutableGsspResponse = {
   headersSent: boolean;
 } & PagesGsspResponse;
@@ -62,8 +62,8 @@ type PagesRenderProps = Record<string, unknown> & {
  * enumerable keys from arrays and primitive wrapper objects are retained.
  * https://github.com/vercel/next.js/blob/canary/packages/next/src/server/render.tsx
  */
-declare function mergePagesDataProps(appPageProps: unknown, dataProps: unknown): Record<string, unknown>;
-type PagesPageModule = {
+export declare function mergePagesDataProps(appPageProps: unknown, dataProps: unknown): Record<string, unknown>;
+export type PagesPageModule = {
   default?: unknown;
   getStaticPaths?: (context: {
     locales: string[];
@@ -130,7 +130,7 @@ type RenderPagesIsrHtmlOptions = {
   vinext?: VinextNextData["__vinext"];
   nextData?: PagesNextDataExtras;
 };
-type ResolvePagesPageDataOptions = {
+export type ResolvePagesPageDataOptions = {
   applyRequestContexts: () => void;
   basePath?: string;
   buildId: string | null;
@@ -149,8 +149,11 @@ type ResolvePagesPageDataOptions = {
   createPageElement: (props: Record<string, unknown>) => ReactNode;
   fontLinkHeader: string;
   i18n: PagesI18nRenderContext;
+  /** Build-time default locale, which can differ from a domain's render default. */
+  staticPathsDefaultLocale?: string;
   isrCacheKey: (router: string, pathname: string) => string;
   isrGet: (key: string) => Promise<ISRCacheEntry | null>;
+  hasPrerenderedPages?: boolean;
   isrSet: (key: string, data: CachedPagesValue | CachedRedirectValue | null, policy: IsrWritePolicy) => Promise<void>;
   expireSeconds?: number;
   /**
@@ -216,6 +219,8 @@ type ResolvePagesPageDataOptions = {
   sanitizeDestination: (destination: string) => string;
   scriptNonce?: string;
   statusCode?: number;
+  /** Request-local headers inherited when rendering a source page's notFound result. */
+  notFoundSourceHeaders?: Record<string, string | number | boolean | string[]>;
   triggerBackgroundRegeneration: (key: string, renderFn: () => Promise<void>, errorContext?: {
     routerKind: "Pages Router";
     routePath: string;
@@ -284,15 +289,15 @@ type ResolvePagesPageDataNotFoundResult = {
   cacheState?: "MISS" | "HIT" | "STALE";
 };
 type ResolvePagesPageDataResult = ResolvePagesPageDataRenderResult | ResolvePagesPageDataResponseResult | ResolvePagesPageDataNotFoundResult;
-declare function mergePagesNotFoundSourceHeaders(response: Response, sourceHeaders: Record<string, string | number | boolean | string[]> | undefined): Response;
+export declare function mergePagesNotFoundSourceHeaders(response: Response, sourceHeaders: Record<string, string | number | boolean | string[]> | undefined): Response;
 /** Validate and normalize the redirect metadata returned by gSP/gSSP. */
-declare function resolvePagesRedirect(redirect: PagesRedirectResult, options: {
+export declare function resolvePagesRedirect(redirect: PagesRedirectResult, options: {
   method: "getStaticProps" | "getServerSideProps";
   routeUrl: string;
   sanitizeDestination: (destination: string) => string;
 }): ResolvedPagesRedirect;
-declare function resolvePagesRedirectLocation(redirect: ResolvedPagesRedirect, configuredBasePath?: string): string;
-declare function buildPagesRedirectProps(redirect: ResolvedPagesRedirect, props: PagesRenderProps): PagesRenderProps;
+export declare function resolvePagesRedirectLocation(redirect: ResolvedPagesRedirect, configuredBasePath?: string): string;
+export declare function buildPagesRedirectProps(redirect: ResolvedPagesRedirect, props: PagesRenderProps): PagesRenderProps;
 /**
  * Compare a `getStaticPaths` entry against the actual request params.
  *
@@ -308,14 +313,13 @@ declare function buildPagesRedirectProps(redirect: ResolvedPagesRedirect, props:
  * entry with a missing `params` key, return false rather than throwing — the
  * caller will respond with a 404 just like Next.js does for unlisted paths.
  */
-type PagesRouteParam = {
+export type PagesRouteParam = {
   key: string;
   repeat: boolean;
   optional: boolean;
 };
-declare function getPagesRouteParams(routePattern: string): PagesRouteParam[];
-declare function matchesPagesStaticPath(pathEntry: PagesStaticPathsEntry, params: Record<string, unknown>, routeParams: PagesRouteParam[], routeUrl: string): boolean;
-declare function renderPagesIsrHtml(options: RenderPagesIsrHtmlOptions): Promise<string>;
-declare function resolvePagesPageData(options: ResolvePagesPageDataOptions): Promise<ResolvePagesPageDataResult>;
-//#endregion
-export { PagesPageModule, PagesRedirectResult, PagesRouteParam, PagesStaticPathsEntry, ResolvePagesPageDataOptions, ResolvedPagesRedirect, assertPages404DoesNotReturnNotFound, buildPagesRedirectProps, getPagesRouteParams, matchesPagesStaticPath, mergePagesDataProps, mergePagesNotFoundSourceHeaders, renderPagesIsrHtml, resolvePagesPageData, resolvePagesRedirect, resolvePagesRedirectLocation, resolvePagesRevalidateSeconds };
+export declare function getPagesRouteParams(routePattern: string): PagesRouteParam[];
+export declare function matchesPagesStaticPath(pathEntry: PagesStaticPathsEntry, params: Record<string, unknown>, routeParams: PagesRouteParam[], routeUrl: string, i18n?: Pick<PagesI18nRenderContext, "locale" | "locales" | "defaultLocale">): boolean;
+export declare function renderPagesIsrHtml(options: RenderPagesIsrHtmlOptions): Promise<string>;
+export declare function resolvePagesPageData(options: ResolvePagesPageDataOptions): Promise<ResolvePagesPageDataResult>;
+//#endregion