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

package/dist/shims/url-safety.d.ts

@@ -29,6 +29,6 @@ declare function isDangerousScheme(url: string): boolean;
  *   packages/next/src/shared/lib/router/router.ts:1025,1057
  */
 declare function reportBlockedDangerousNavigation(): void;
-declare function assertSafeNavigationUrl(url: string): void;
+declare function assertSafeNavigationUrl(url: string, ErrorConstructor?: new (message: string) => Error): void;
 //#endregion
 export { DANGEROUS_URL_BLOCK_MESSAGE, assertSafeNavigationUrl, isDangerousScheme, reportBlockedDangerousNavigation };

package/dist/shims/url-safety.js

@@ -60,10 +60,10 @@ function isDangerousScheme(url) {
 function reportBlockedDangerousNavigation() {
 	console.error(DANGEROUS_URL_BLOCK_MESSAGE);
 }
-function assertSafeNavigationUrl(url) {
+function assertSafeNavigationUrl(url, ErrorConstructor = Error) {
 	if (isDangerousScheme(url)) {
 		reportBlockedDangerousNavigation();
-		throw new Error(DANGEROUS_URL_BLOCK_MESSAGE);
+		throw new ErrorConstructor(DANGEROUS_URL_BLOCK_MESSAGE);
 	}
 }
 //#endregion

package/dist/typegen.d.ts

@@ -4,6 +4,12 @@ type GenerateRouteTypesOptions = {
   appDir?: string | null;
   pageExtensions?: readonly string[];
 };
-declare function generateRouteTypes(options: GenerateRouteTypesOptions): Promise<string>;
+type GenerateRouteTypesResult = {
+  routeTypesPath: string;
+  nextEnvPath: string;
+  nextEnvStatus: "created" | "updated" | "unchanged";
+};
+declare function nextEnvFileContent(hasNext: boolean, hasAppDir: boolean, eol?: string): string;
+declare function generateRouteTypes(options: GenerateRouteTypesOptions): Promise<GenerateRouteTypesResult>;
 //#endregion
-export { generateRouteTypes };
+export { GenerateRouteTypesResult, generateRouteTypes, nextEnvFileContent };

package/dist/typegen.js

@@ -4,34 +4,82 @@ import { decodeRouteSegment, isInvisibleSegment } from "./routing/utils.js";
 import { patternToNextFormat } from "./routing/route-validation.js";
 import { compareStrings } from "./utils/compare.js";
 import { appRouteGraph } from "./routing/app-router.js";
+import { createRequire } from "node:module";
 import fsp from "node:fs/promises";
+import os from "node:os";
 //#region src/typegen.ts
-const NEXT_ENV_FILE_CONTENT = `/// <reference types="next" />
+function nextEnvFileContent(hasNext, hasAppDir, eol = "\n") {
+	return `${hasNext ? `/// <reference types="next" />
 /// <reference types="next/image-types/global" />
-import "./.next/types/routes.d.ts";
+import "vinext/types/augmentations";
+` : `import "vinext/types";
+`}import "./.next/types/routes.d.ts";
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
-`;
+// see https://nextjs.org/docs/${hasAppDir ? "app" : "pages"}/api-reference/config/typescript for more information.
+`.replaceAll("\n", eol);
+}
 async function generateRouteTypes(options) {
 	const root = path.resolve(options.root);
-	const appDir = options.appDir ? path.resolve(options.appDir) : findDir(root, "app", "src/app");
+	const appDir = options.appDir === null ? null : options.appDir ? path.resolve(options.appDir) : findDir(root, "app", "src/app");
 	const outPath = path.join(root, ".next", "types", "routes.d.ts");
-	const content = appDir ? renderRouteTypes(await collectRouteTypeModel(appDir, options.pageExtensions)) : renderRouteTypes(emptyRouteTypeModel());
+	const pagesDir = findDir(root, "pages", "src/pages");
+	const content = appDir ? renderRouteTypes(await collectRouteTypeModel(appDir, options.pageExtensions), pagesDir !== null) : renderRouteTypes(emptyRouteTypeModel(), false);
 	await fsp.mkdir(path.dirname(outPath), { recursive: true });
 	await fsp.writeFile(outPath, content, "utf-8");
-	await ensureNextEnvFile(root);
-	return outPath;
+	const nextEnv = await ensureNextEnvFile(root, appDir !== null);
+	return {
+		routeTypesPath: outPath,
+		nextEnvPath: nextEnv.path,
+		nextEnvStatus: nextEnv.status
+	};
 }
-async function ensureNextEnvFile(root) {
+async function ensureNextEnvFile(root, hasAppDir) {
 	const envPath = path.join(root, "next-env.d.ts");
+	let eol = os.EOL;
+	let existing;
 	try {
-		await fsp.writeFile(envPath, NEXT_ENV_FILE_CONTENT, {
-			encoding: "utf-8",
-			flag: "wx"
+		existing = await fsp.readFile(envPath, "utf-8");
+		const newline = existing.indexOf("\n", 1);
+		if (newline !== -1) eol = existing[newline - 1] === "\r" ? "\r\n" : "\n";
+	} catch (error) {
+		if (error.code !== "ENOENT") throw error;
+	}
+	const content = nextEnvFileContent(await hasNextPackage(root), hasAppDir, eol);
+	if (existing === content) return {
+		path: envPath,
+		status: "unchanged"
+	};
+	await fsp.writeFile(envPath, content, "utf-8");
+	return {
+		path: envPath,
+		status: existing === void 0 ? "created" : "updated"
+	};
+}
+async function hasNextPackage(root) {
+	const manifestPath = path.join(root, "package.json");
+	let declaresNext;
+	try {
+		const manifest = JSON.parse(await fsp.readFile(manifestPath, "utf-8"));
+		declaresNext = [
+			"dependencies",
+			"devDependencies",
+			"peerDependencies",
+			"optionalDependencies"
+		].some((field) => {
+			const dependencies = manifest[field];
+			return typeof dependencies === "object" && dependencies !== null && Object.hasOwn(dependencies, "next");
 		});
 	} catch (error) {
-		if (error.code !== "EEXIST") throw error;
+		if (error.code !== "ENOENT") throw error;
+	}
+	if (declaresNext === false) return false;
+	try {
+		const packageJsonPath = createRequire(manifestPath).resolve("next/package.json");
+		await fsp.access(packageJsonPath);
+		return true;
+	} catch {
+		return false;
 	}
 }
 function emptyRouteTypeModel() {
@@ -84,12 +132,23 @@ async function collectRouteTypeModel(appDir, pageExtensions) {
 	for (const slotNames of model.layoutSlots.values()) slotNames.sort(compareStrings);
 	return model;
 }
-function renderRouteTypes(model) {
+function renderRouteTypes(model, hasPagesCompat) {
 	const allRoutes = uniqueSorted([
 		...model.pageRoutes,
 		...model.layoutRoutes,
 		...model.routeHandlerRoutes
 	]);
+	const navigationCompat = hasPagesCompat ? `
+declare module "next/navigation" {
+  function useSearchParams(): import("next/navigation").ReadonlyURLSearchParams | null;
+  function usePathname(): string | null;
+  function useParams<
+    T extends Record<string, string | string[]> = Record<string, string | string[]>,
+  >(): T | null;
+  function useSelectedLayoutSegments(): string[] | null;
+  function useSelectedLayoutSegment(): string | null;
+}
+` : "";
 	return `// This file is generated by vinext. Do not edit.
 import type * as React from "react";
 
@@ -126,6 +185,8 @@ ${renderLayoutSlotMap(model.layoutRoutes, model.layoutSlots)}
   }
 }
 
+${navigationCompat}
+
 export {};
 `;
 }
@@ -224,4 +285,4 @@ function quote(value) {
 	return JSON.stringify(value);
 }
 //#endregion
-export { generateRouteTypes };
+export { generateRouteTypes, nextEnvFileContent };

package/dist/utils/cache-control-metadata.d.ts

@@ -1,4 +1,5 @@
 //#region src/utils/cache-control-metadata.d.ts
 declare function readCacheControlNumberField(ctx: Record<string, unknown> | undefined, field: string): number | undefined;
+declare function readCacheControlRevalidateField(ctx: Record<string, unknown> | undefined): number | false | undefined;
 //#endregion
-export { readCacheControlNumberField };
+export { readCacheControlNumberField, readCacheControlRevalidateField };

package/dist/utils/cache-control-metadata.js

@@ -8,5 +8,9 @@ function readCacheControlNumberField(ctx, field) {
 	const value = readRecordField(ctx, "cacheControl")?.[field] ?? ctx?.[field];
 	return typeof value === "number" ? value : void 0;
 }
+function readCacheControlRevalidateField(ctx) {
+	const value = readRecordField(ctx, "cacheControl")?.revalidate ?? ctx?.revalidate;
+	return typeof value === "number" || value === false ? value : void 0;
+}
 //#endregion
-export { readCacheControlNumberField };
+export { readCacheControlNumberField, readCacheControlRevalidateField };

package/dist/utils/domain-locale.d.ts

@@ -2,8 +2,8 @@
 type DomainLocale = {
   domain: string;
   defaultLocale: string;
-  locales?: string[];
-  http?: boolean;
+  locales?: readonly string[];
+  http?: true;
 };
 declare function normalizeDomainHostname(hostname: string | null | undefined): string | undefined;
 /**

package/dist/utils/external-url.d.ts

@@ -0,0 +1,5 @@
+//#region src/utils/external-url.d.ts
+/** Detect an absolute URL with any scheme, or a protocol-relative URL. */
+declare function isExternalUrl(url: string): boolean;
+//#endregion
+export { isExternalUrl };

package/dist/utils/external-url.js

@@ -0,0 +1,7 @@
+//#region src/utils/external-url.ts
+/** Detect an absolute URL with any scheme, or a protocol-relative URL. */
+function isExternalUrl(url) {
+	return /^[a-z][a-z0-9+.-]*:/i.test(url) || url.startsWith("//");
+}
+//#endregion
+export { isExternalUrl };

package/dist/utils/html-limited-bots.js

@@ -1,5 +1,5 @@
 //#region src/utils/html-limited-bots.ts
-const HTML_LIMITED_BOT_UA_RE_STRING = String.raw`[\w-]+-Google|Google-[\w-]+|Chrome-Lighthouse|Slurp|DuckDuckBot|baiduspider|yandex|sogou|bitlybot|tumblr|vkShare|quora link preview|redditbot|ia_archiver|Bingbot|BingPreview|applebot|facebookexternalhit|facebookcatalog|Twitterbot|LinkedInBot|Slackbot|Discordbot|WhatsApp|SkypeUriPreview|Yeti|googleweblight`;
+const HTML_LIMITED_BOT_UA_RE_STRING = String.raw`[\w-]+-Google|Google-[\w-]+|Chrome-Lighthouse|Slurp|DuckDuckBot|baiduspider|yandex|sogou|bitlybot|tumblr|vkShare|quora link preview|redditbot|ia_archiver|Bingbot|BingPreview|applebot|facebookexternalhit|facebookcatalog|meta-externalagent|meta-externalfetcher|Twitterbot|LinkedInBot|Slackbot|Discordbot|WhatsApp|SkypeUriPreview|Yeti|googleweblight`;
 const HEADLESS_BROWSER_BOT_UA_RE = /Googlebot(?!-)|Googlebot$/i;
 const htmlLimitedBotRegexCache = /* @__PURE__ */ new Map();
 function getHtmlLimitedBotRegex(htmlLimitedBots) {

package/dist/utils/protocol-headers.d.ts

@@ -7,6 +7,8 @@ declare const VINEXT_PRERENDER_SECRET_HEADER = "x-vinext-prerender-secret";
 declare const VINEXT_PRERENDER_ROUTE_PARAMS_HEADER = "x-vinext-prerender-route-params";
 /** Indicates a build-time prerender render is probing whether a route can be static. */
 declare const VINEXT_PRERENDER_SPECULATIVE_HEADER = "x-vinext-prerender-speculative";
+/** Logical hostname carried only by authenticated Node revalidation loopbacks. */
+declare const VINEXT_REVALIDATE_HOST_HEADER = "x-vinext-revalidate-host";
 /** Prefix for forwarded request headers (e.g. `x-middleware-request-cookie`). */
 declare const MIDDLEWARE_REQUEST_HEADER_PREFIX = "x-middleware-request-";
 /** Comma-separated list of header names that middleware wants to override. */
@@ -19,5 +21,9 @@ declare const MIDDLEWARE_CACHE_HEADER = "x-middleware-cache";
 declare const MIDDLEWARE_SKIP_HEADER = "x-middleware-skip";
 /** Generic prefix for all middleware internal headers. */
 declare const MIDDLEWARE_HEADER_PREFIX = "x-middleware-";
+/** Authenticates an internal Pages Router on-demand revalidation request. */
+declare const PRERENDER_REVALIDATE_HEADER = "x-prerender-revalidate";
+/** Restricts on-demand revalidation to paths that were already generated. */
+declare const PRERENDER_REVALIDATE_ONLY_GENERATED_HEADER = "x-prerender-revalidate-if-generated";
 //#endregion
-export { MIDDLEWARE_CACHE_HEADER, MIDDLEWARE_HEADER_PREFIX, MIDDLEWARE_OVERRIDE_HEADERS, MIDDLEWARE_REQUEST_HEADER_PREFIX, MIDDLEWARE_SET_COOKIE_HEADER, MIDDLEWARE_SKIP_HEADER, VINEXT_MW_CTX_HEADER, VINEXT_PRERENDER_ROUTE_PARAMS_HEADER, VINEXT_PRERENDER_SECRET_HEADER, VINEXT_PRERENDER_SPECULATIVE_HEADER };
+export { MIDDLEWARE_CACHE_HEADER, MIDDLEWARE_HEADER_PREFIX, MIDDLEWARE_OVERRIDE_HEADERS, MIDDLEWARE_REQUEST_HEADER_PREFIX, MIDDLEWARE_SET_COOKIE_HEADER, MIDDLEWARE_SKIP_HEADER, PRERENDER_REVALIDATE_HEADER, PRERENDER_REVALIDATE_ONLY_GENERATED_HEADER, VINEXT_MW_CTX_HEADER, VINEXT_PRERENDER_ROUTE_PARAMS_HEADER, VINEXT_PRERENDER_SECRET_HEADER, VINEXT_PRERENDER_SPECULATIVE_HEADER, VINEXT_REVALIDATE_HOST_HEADER };

package/dist/utils/protocol-headers.js

@@ -7,6 +7,8 @@ const VINEXT_PRERENDER_SECRET_HEADER = "x-vinext-prerender-secret";
 const VINEXT_PRERENDER_ROUTE_PARAMS_HEADER = "x-vinext-prerender-route-params";
 /** Indicates a build-time prerender render is probing whether a route can be static. */
 const VINEXT_PRERENDER_SPECULATIVE_HEADER = "x-vinext-prerender-speculative";
+/** Logical hostname carried only by authenticated Node revalidation loopbacks. */
+const VINEXT_REVALIDATE_HOST_HEADER = "x-vinext-revalidate-host";
 /** Prefix for forwarded request headers (e.g. `x-middleware-request-cookie`). */
 const MIDDLEWARE_REQUEST_HEADER_PREFIX = "x-middleware-request-";
 /** Comma-separated list of header names that middleware wants to override. */
@@ -19,5 +21,9 @@ const MIDDLEWARE_CACHE_HEADER = "x-middleware-cache";
 const MIDDLEWARE_SKIP_HEADER = "x-middleware-skip";
 /** Generic prefix for all middleware internal headers. */
 const MIDDLEWARE_HEADER_PREFIX = "x-middleware-";
+/** Authenticates an internal Pages Router on-demand revalidation request. */
+const PRERENDER_REVALIDATE_HEADER = "x-prerender-revalidate";
+/** Restricts on-demand revalidation to paths that were already generated. */
+const PRERENDER_REVALIDATE_ONLY_GENERATED_HEADER = "x-prerender-revalidate-if-generated";
 //#endregion
-export { MIDDLEWARE_CACHE_HEADER, MIDDLEWARE_HEADER_PREFIX, MIDDLEWARE_OVERRIDE_HEADERS, MIDDLEWARE_REQUEST_HEADER_PREFIX, MIDDLEWARE_SET_COOKIE_HEADER, MIDDLEWARE_SKIP_HEADER, VINEXT_MW_CTX_HEADER, VINEXT_PRERENDER_ROUTE_PARAMS_HEADER, VINEXT_PRERENDER_SECRET_HEADER, VINEXT_PRERENDER_SPECULATIVE_HEADER };
+export { MIDDLEWARE_CACHE_HEADER, MIDDLEWARE_HEADER_PREFIX, MIDDLEWARE_OVERRIDE_HEADERS, MIDDLEWARE_REQUEST_HEADER_PREFIX, MIDDLEWARE_SET_COOKIE_HEADER, MIDDLEWARE_SKIP_HEADER, PRERENDER_REVALIDATE_HEADER, PRERENDER_REVALIDATE_ONLY_GENERATED_HEADER, VINEXT_MW_CTX_HEADER, VINEXT_PRERENDER_ROUTE_PARAMS_HEADER, VINEXT_PRERENDER_SECRET_HEADER, VINEXT_PRERENDER_SPECULATIVE_HEADER, VINEXT_REVALIDATE_HOST_HEADER };

package/dist/utils/regex-safety.d.ts

@@ -0,0 +1,8 @@
+//#region src/utils/regex-safety.d.ts
+type RegexSafetyIssue = "nested repetition" | "ambiguous alternatives under repetition" | "ambiguous sequence expansion" | "overlapping sequential repetition" | "analysis budget exceeded";
+declare function analyzeRegexSafety(pattern: string, options?: {
+  ignoreCase?: boolean;
+}): RegexSafetyIssue | null;
+declare function regexAtomsMayOverlap(left: string, right: string, ignoreCase?: boolean): boolean;
+//#endregion
+export { RegexSafetyIssue, analyzeRegexSafety, regexAtomsMayOverlap };