vinext 1.0.0-beta.1 → 1.0.0-beta.3

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

@@ -1,8 +1,9 @@
 import { Route } from "../routing/pages-router.js";
 import { VinextNextData } from "../client/vinext-next-data.js";
-import { CachedPagesValue } from "../shims/cache-handler.js";
+import { CachedPagesValue, CachedRedirectValue } from "../shims/cache-handler.js";
 import { ISRCacheEntry } from "./isr-cache.js";
 import { PagesPreviewData } from "./pages-preview.js";
+import { PagesGetInitialPropsRouter } from "./pages-get-initial-props.js";
 import { PagesGsspResponse, PagesI18nRenderContext, PagesNextDataExtras } from "./pages-page-response.js";
 import { ReactNode } from "react";
 
@@ -11,6 +12,12 @@ type PagesRedirectResult = {
   destination: string;
   permanent?: boolean;
   statusCode?: number;
+  basePath?: boolean;
+};
+type ResolvedPagesRedirect = {
+  destination: string;
+  statusCode: number;
+  basePath?: boolean;
 };
 type PagesStaticPathsEntry = string | {
   params?: Record<string, unknown>;
@@ -21,11 +28,23 @@ type PagesStaticPathsResult = {
   paths?: PagesStaticPathsEntry[];
 };
 type PagesPagePropsResult = {
-  props?: Record<string, unknown>;
+  props?: Record<string, unknown> | Promise<Record<string, unknown>>;
   redirect?: PagesRedirectResult;
   notFound?: boolean;
-  revalidate?: number;
+  revalidate?: unknown;
 };
+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;
+ * storing it as a revalidation deadline would incorrectly regenerate static
+ * pages after one year.
+ *
+ * Next.js source:
+ * - 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;
 type PagesMutableGsspResponse = {
   headersSent: boolean;
 } & PagesGsspResponse;
@@ -35,8 +54,16 @@ type PagesGsspContextResponse = {
   responsePromise: Promise<Response>;
 };
 type PagesRenderProps = Record<string, unknown> & {
-  pageProps: unknown;
+  pageProps?: unknown;
 };
+/**
+ * Merge gSP/gSSP data into the custom App's raw pageProps value.
+ *
+ * Next.js deliberately uses Object.assign rather than object spread, so
+ * 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 = {
   default?: unknown;
   getStaticPaths?: (context: {
@@ -105,6 +132,7 @@ type RenderPagesIsrHtmlOptions = {
 };
 type ResolvePagesPageDataOptions = {
   applyRequestContexts: () => void;
+  basePath?: string;
   buildId: string | null;
   /**
    * When true, this is a `/_next/data/<buildId>/<page>.json` request. Callers
@@ -123,7 +151,7 @@ type ResolvePagesPageDataOptions = {
   i18n: PagesI18nRenderContext;
   isrCacheKey: (router: string, pathname: string) => string;
   isrGet: (key: string) => Promise<ISRCacheEntry | null>;
-  isrSet: (key: string, data: CachedPagesValue, revalidateSeconds: number, tags?: string[], expireSeconds?: number) => Promise<void>;
+  isrSet: (key: string, data: CachedPagesValue | CachedRedirectValue | null, revalidateSeconds: number | false, tags?: string[], expireSeconds?: number) => Promise<void>;
   expireSeconds?: number;
   /**
    * When true, this dispatch corresponds to a build-time prerender (the
@@ -151,6 +179,12 @@ type ResolvePagesPageDataOptions = {
    * presence — see the security note in `isr-cache.ts`.
    */
   isOnDemandRevalidate?: boolean;
+  /**
+   * When true alongside an authenticated on-demand request, return a
+   * successful 404 no-op if no cache entry exists instead of generating a new
+   * fallback path. Mirrors Next.js `unstable_onlyGenerated`.
+   */
+  revalidateOnlyGenerated?: boolean;
   previewData?: PagesPreviewData | false;
   /**
    * The deployment ID used for deployment-skew protection. When set, it is
@@ -161,7 +195,8 @@ type ResolvePagesPageDataOptions = {
   deploymentId?: string;
   htmlLimitedBots?: string;
   pageModule: PagesPageModule;
-  AppComponent?: unknown;
+  AppComponent?: unknown; /** The request-scoped `next/router` server instance when available. */
+  router?: PagesGetInitialPropsRouter;
   params: Record<string, unknown>;
   query: Record<string, unknown>;
   asPath?: string;
@@ -169,6 +204,12 @@ type ResolvePagesPageDataOptions = {
   route: Pick<Route, "isDynamic">;
   routePattern: string;
   routeUrl: string;
+  /**
+   * Filesystem-route identity used for Pages ISR reads and writes. Error pages
+   * render against the original request URL but cache under /404, /500, or
+   * /_error, matching Next.js's error-page cache-key override.
+   */
+  isrCachePathname?: string;
   runInFreshUnifiedContext: <T>(callback: () => Promise<T>) => Promise<T>;
   safeJsonStringify: (value: unknown) => string;
   sanitizeDestination: (destination: string) => string;
@@ -208,7 +249,8 @@ type ResolvePagesPageDataRenderResult = {
   kind: "render";
   documentReqRes: PagesGsspContextResponse | null;
   gsspRes: PagesGsspResponse | null;
-  isrRevalidateSeconds: number | null;
+  isrRevalidateSeconds: number | false | null;
+  isrExpireSeconds?: number;
   pageProps: Record<string, unknown>;
   props: PagesRenderProps;
   /**
@@ -221,12 +263,24 @@ type ResolvePagesPageDataRenderResult = {
 };
 type ResolvePagesPageDataResponseResult = {
   kind: "response";
-  response: Response;
+  response: Response; /** False when an on-demand request must be reported as a failed revalidation. */
+  onDemandRevalidateSuccess?: boolean;
 };
 type ResolvePagesPageDataNotFoundResult = {
-  kind: "notFound";
+  kind: "notFound"; /** Current getStaticProps cache lifetime, when this is an SSG result. */
+  revalidateSeconds?: number | false;
+  expireSeconds?: number;
+  cacheState?: "MISS" | "HIT" | "STALE";
 };
 type ResolvePagesPageDataResult = ResolvePagesPageDataRenderResult | ResolvePagesPageDataResponseResult | ResolvePagesPageDataNotFoundResult;
+/** Validate and normalize the redirect metadata returned by gSP/gSSP. */
+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;
 /**
  * Compare a `getStaticPaths` entry against the actual request params.
  *
@@ -252,4 +306,4 @@ declare function matchesPagesStaticPath(pathEntry: PagesStaticPathsEntry, params
 declare function renderPagesIsrHtml(options: RenderPagesIsrHtmlOptions): Promise<string>;
 declare function resolvePagesPageData(options: ResolvePagesPageDataOptions): Promise<ResolvePagesPageDataResult>;
 //#endregion
-export { PagesPageModule, PagesRouteParam, PagesStaticPathsEntry, ResolvePagesPageDataOptions, getPagesRouteParams, matchesPagesStaticPath, renderPagesIsrHtml, resolvePagesPageData };
+export { PagesPageModule, PagesRedirectResult, PagesRouteParam, PagesStaticPathsEntry, ResolvePagesPageDataOptions, ResolvedPagesRedirect, assertPages404DoesNotReturnNotFound, buildPagesRedirectProps, getPagesRouteParams, matchesPagesStaticPath, mergePagesDataProps, renderPagesIsrHtml, resolvePagesPageData, resolvePagesRedirect, resolvePagesRedirectLocation, resolvePagesRevalidateSeconds };