@vercel/fs-detectors 6.13.2 → 6.14.0

package/dist/detect-builders.d.ts

@@ -4,10 +4,6 @@ import type { PackageJson, Builder, BuilderFunctions, ExperimentalServices, Expe
  * Pattern for finding all supported middleware files.
  */
 export declare const REGEX_MIDDLEWARE_FILES = "middleware.[jt]s";
-/**
- * Pattern for files that the Vercel platform cares about separately from frameworks.
- * These files are excluded from static file serving.
- */
 export declare const REGEX_VERCEL_PLATFORM_FILES: string;
 /**
  * Pattern for non-Vercel platform files.
@@ -19,6 +15,10 @@ export interface ErrorResponse {
     action?: string;
     link?: string;
 }
+export interface ProxyConfig {
+    entrypoint: string;
+    matcher?: string | string[];
+}
 export interface Options {
     tag?: string;
     functions?: BuilderFunctions;
@@ -32,6 +32,7 @@ export interface Options {
     featHandleMiss?: boolean;
     bunVersion?: string;
     workPath?: string;
+    proxy?: ProxyConfig;
 }
 export declare function sortFiles(fileA: string, fileB: string): number;
 export declare function detectApiExtensions(builders: Builder[]): Set<string>;
@@ -51,3 +52,10 @@ export declare function detectBuilders(files: string[], pkg?: PackageJson | unde
     experimentalServicesV2?: Services;
     useImplicitEnvInjection?: boolean;
 }>;
+export declare function getProxyBuilder(proxy: ProxyConfig, tag?: string, functions?: BuilderFunctions): Builder;
+/**
+ * Validates a `proxy` config value in isolation, without knowledge of the
+ * project's files or framework. Also used by the CLI to validate
+ * `vercel.json` before builders are detected.
+ */
+export declare function validateProxyConfig(proxy: ProxyConfig): ErrorResponse | null;

package/dist/detect-builders.js

@@ -35,7 +35,9 @@ __export(detect_builders_exports, {
   detectApiExtensions: () => detectApiExtensions,
   detectBuilders: () => detectBuilders,
   detectOutputDirectory: () => detectOutputDirectory,
-  sortFiles: () => sortFiles
+  getProxyBuilder: () => getProxyBuilder,
+  sortFiles: () => sortFiles,
+  validateProxyConfig: () => validateProxyConfig
 });
 module.exports = __toCommonJS(detect_builders_exports);
 var import_minimatch = __toESM(require("minimatch"));
@@ -46,7 +48,7 @@ var import_is_official_runtime = require("./is-official-runtime");
 var import_build_utils = require("@vercel/build-utils");
 var import_get_services_builders = require("./services/get-services-builders");
 const REGEX_MIDDLEWARE_FILES = "middleware.[jt]s";
-const REGEX_VERCEL_PLATFORM_FILES = [
+const VERCEL_PLATFORM_FILES = [
   "api/**",
   "node_modules/**",
   REGEX_MIDDLEWARE_FILES,
@@ -58,8 +60,18 @@ const REGEX_VERCEL_PLATFORM_FILES = [
   "bun.lockb",
   ".gitignore",
   "README.md"
-].join(",");
-const REGEX_NON_VERCEL_PLATFORM_FILES = `!{${REGEX_VERCEL_PLATFORM_FILES}}`;
+];
+const REGEX_VERCEL_PLATFORM_FILES = VERCEL_PLATFORM_FILES.join(",");
+function escapeMinimatchPath(path) {
+  return path.replace(/([\\,*?[\]{}()!+@])/g, "\\$1");
+}
+function getStaticFilesPattern(additionalExclusions = []) {
+  return `!{${[
+    ...VERCEL_PLATFORM_FILES,
+    ...additionalExclusions.map(escapeMinimatchPath)
+  ].join(",")}}`;
+}
+const REGEX_NON_VERCEL_PLATFORM_FILES = getStaticFilesPattern();
 const slugToFramework = new Map(
   import_frameworks.frameworkList.map((f) => [f.slug, f])
 );
@@ -115,6 +127,18 @@ async function detectBuilders(files, pkg, options = {}) {
     };
   }
   const { framework } = projectSettings;
+  const proxyError = validateProxy(options, files, framework);
+  if (proxyError) {
+    return {
+      builders: null,
+      errors: [proxyError],
+      warnings: [],
+      defaultRoutes: null,
+      redirectRoutes: null,
+      rewriteRoutes: null,
+      errorRoutes: null
+    };
+  }
   const servicesConfig = services ?? experimentalServicesV2;
   const configuredServices = servicesConfig ?? experimentalServicesV1;
   const configuredServicesType = servicesConfig ? services ? "services" : "experimentalServicesV2" : "experimentalServices";
@@ -131,6 +155,12 @@ async function detectBuilders(files, pkg, options = {}) {
         ...(0, import_get_services_builders.warnIgnoredDirectories)(files, configuredServices)
       );
     }
+    if (!result.errors && options.proxy) {
+      result.builders = [
+        getProxyBuilder(options.proxy, options.tag, options.functions),
+        ...result.builders ?? []
+      ];
+    }
     return result;
   }
   const errors = [];
@@ -181,6 +211,9 @@ async function detectBuilders(files, pkg, options = {}) {
   const apiRoutes = [];
   const dynamicRoutes = [];
   for (const fileName of sortedFiles) {
+    if (fileName === options.proxy?.entrypoint) {
+      continue;
+    }
     const apiBuilder = await maybeGetApiBuilder(fileName, apiMatches, options);
     if (apiBuilder) {
       const { routeError, apiRoute, isDynamic } = getApiRoute(
@@ -223,6 +256,15 @@ async function detectBuilders(files, pkg, options = {}) {
       fallbackEntrypoint = fileName;
     }
   }
+  if (options.proxy) {
+    const proxyBuilder = getProxyBuilder(
+      options.proxy,
+      options.tag,
+      options.functions
+    );
+    addToUsedFunctions(proxyBuilder);
+    apiBuilders.unshift(proxyBuilder);
+  }
   if (!makeFrontendStatic && (hasBuildScript(pkg) || buildCommand || framework)) {
     frontendBuilder = detectFrontBuilder(
       pkg,
@@ -256,13 +298,31 @@ async function detectBuilders(files, pkg, options = {}) {
     } else if (apiBuilders.length && hasNoneApiFiles) {
       frontendBuilder = {
         use: "@vercel/static",
-        src: REGEX_NON_VERCEL_PLATFORM_FILES,
+        src: getStaticFilesPattern(
+          options.proxy ? [options.proxy.entrypoint] : []
+        ),
         config: {
           zeroConfig: true
         }
       };
     }
   }
+  if (options.proxy && frontendBuilder && (0, import_is_official_runtime.isOfficialRuntime)("next", frontendBuilder.use)) {
+    return {
+      builders: null,
+      errors: [
+        {
+          code: "proxy_framework_conflict",
+          message: "The `proxy` property cannot be used with Next.js because the framework builds its own routing middleware."
+        }
+      ],
+      warnings,
+      defaultRoutes: null,
+      redirectRoutes: null,
+      rewriteRoutes: null,
+      errorRoutes: null
+    };
+  }
   const unusedFunctionError = checkUnusedFunctions(
     frontendBuilder,
     usedFunctions,
@@ -329,7 +389,7 @@ async function detectBuilders(files, pkg, options = {}) {
   };
 }
 async function maybeGetApiBuilder(fileName, apiMatches, options) {
-  const middleware = fileName === "middleware.js" || fileName === "middleware.ts";
+  const middleware = !options.proxy && (fileName === "middleware.js" || fileName === "middleware.ts");
   if (middleware && options.projectSettings?.framework === "nextjs") {
     return null;
   }
@@ -402,6 +462,30 @@ function getFunction(fileName, { functions = {} }) {
   const func = keys.find((key) => key === fileName || (0, import_minimatch.default)(fileName, key));
   return func ? { fnPattern: func, func: functions[func] } : { fnPattern: null, func: null };
 }
+function getProxyBuilder(proxy, tag, functions = {}) {
+  const { fnPattern, func } = getFunction(proxy.entrypoint, { functions });
+  const runtime = func?.runtime;
+  const config = {
+    zeroConfig: true,
+    middleware: true,
+    ...!runtime ? { middlewareRuntime: "nodejs" } : {},
+    ...proxy.matcher ? { middlewareMatcher: proxy.matcher } : {}
+  };
+  if (fnPattern && func) {
+    config.functions = { [fnPattern]: func };
+    if (func.includeFiles) {
+      config.includeFiles = func.includeFiles;
+    }
+    if (func.excludeFiles) {
+      config.excludeFiles = func.excludeFiles;
+    }
+  }
+  return {
+    src: proxy.entrypoint,
+    use: runtime || `@vercel/node${tag ? `@${tag}` : ""}`,
+    config
+  };
+}
 function getApiMatches() {
   const config = { zeroConfig: true };
   return [
@@ -417,6 +501,63 @@ function getApiMatches() {
     { src: "api/**/*.rs", use: `@vercel/rust`, config }
   ];
 }
+function validateProxyConfig(proxy) {
+  if (typeof proxy !== "object" || typeof proxy.entrypoint !== "string" || !proxy.entrypoint) {
+    return {
+      code: "invalid_proxy",
+      message: "The `proxy` property must contain an `entrypoint` string that references a `.js` or `.ts` file."
+    };
+  }
+  const entrypoint = proxy.entrypoint;
+  const segments = entrypoint.split("/");
+  if (entrypoint.startsWith("/") || entrypoint.includes("\\") || segments.includes(".") || segments.includes("..") || /[?#\u0000-\u001f]/.test(entrypoint)) {
+    return {
+      code: "invalid_proxy_entrypoint",
+      message: "The `proxy.entrypoint` path must be relative to the project root and cannot contain traversal, query, fragment, or control characters."
+    };
+  }
+  if (!/\.(?:js|ts)$/.test(entrypoint) || entrypoint.endsWith(".d.ts")) {
+    return {
+      code: "invalid_proxy_entrypoint",
+      message: "The `proxy.entrypoint` path must end in `.js` or `.ts` and reference an executable file."
+    };
+  }
+  if (proxy.matcher !== void 0) {
+    const matchers = Array.isArray(proxy.matcher) ? proxy.matcher : [proxy.matcher];
+    if (matchers.length === 0 || matchers.some(
+      (matcher) => typeof matcher !== "string" || !matcher.startsWith("/")
+    )) {
+      return {
+        code: "invalid_proxy_matcher",
+        message: "The `proxy.matcher` value must be a path matcher starting with `/`, or an array of path matchers starting with `/`."
+      };
+    }
+  }
+  return null;
+}
+function validateProxy(options, files, framework) {
+  const { proxy } = options;
+  if (!proxy) {
+    return null;
+  }
+  const configError = validateProxyConfig(proxy);
+  if (configError) {
+    return configError;
+  }
+  if (!files.includes(proxy.entrypoint)) {
+    return {
+      code: "proxy_entrypoint_not_found",
+      message: `The proxy entrypoint \`${proxy.entrypoint}\` does not exist. Set \`proxy.entrypoint\` to an existing \`.js\` or \`.ts\` file.`
+    };
+  }
+  if (framework === "nextjs" || framework === "astro") {
+    return {
+      code: "proxy_framework_conflict",
+      message: `The \`proxy\` property cannot be used with ${framework === "nextjs" ? "Next.js" : "Astro"} because the framework builds its own routing middleware.`
+    };
+  }
+  return null;
+}
 function hasBuildScript(pkg) {
   const { scripts = {} } = pkg || {};
   return Boolean(scripts && scripts["build"]);
@@ -870,5 +1011,7 @@ function sortFilesBySegmentCount(fileA, fileB) {
   detectApiExtensions,
   detectBuilders,
   detectOutputDirectory,
-  sortFiles
+  getProxyBuilder,
+  sortFiles,
+  validateProxyConfig
 });

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { detectBuilders, detectOutputDirectory, detectApiDirectory, detectApiExtensions, type Options as DetectBuildersOptions, } from './detect-builders';
+export { detectBuilders, detectOutputDirectory, detectApiDirectory, detectApiExtensions, getProxyBuilder, validateProxyConfig, type Options as DetectBuildersOptions, type ProxyConfig, } from './detect-builders';
 export { detectServices, generateServicesRoutes, } from './services/detect-services';
 export { resolveAllConfiguredServicesV2, resolveConfiguredServiceV2, validateServiceConfigV2, } from './services/resolve-v2';
 export { isExperimentalService, isExperimentalServiceV2, } from '@vercel/build-utils';

package/dist/index.js

@@ -46,6 +46,7 @@ __export(src_exports, {
   getInternalServiceWorkerPath: () => import_utils.getInternalServiceWorkerPath,
   getInternalServiceWorkerPathPrefix: () => import_utils.getInternalServiceWorkerPathPrefix,
   getProjectPaths: () => import_get_project_paths.getProjectPaths,
+  getProxyBuilder: () => import_detect_builders.getProxyBuilder,
   getServicesBuilders: () => import_get_services_builders.getServicesBuilders,
   getWorkspacePackagePaths: () => import_get_workspace_package_paths.getWorkspacePackagePaths,
   getWorkspaces: () => import_get_workspaces.getWorkspaces,
@@ -59,6 +60,7 @@ __export(src_exports, {
   packageManagers: () => import_package_managers.packageManagers,
   resolveAllConfiguredServicesV2: () => import_resolve_v2.resolveAllConfiguredServicesV2,
   resolveConfiguredServiceV2: () => import_resolve_v2.resolveConfiguredServiceV2,
+  validateProxyConfig: () => import_detect_builders.validateProxyConfig,
   validateServiceConfigV2: () => import_resolve_v2.validateServiceConfigV2,
   workspaceManagers: () => import_workspace_managers.workspaceManagers
 });
@@ -113,6 +115,7 @@ var import_detect_instrumentation = require("./detect-instrumentation");
   getInternalServiceWorkerPath,
   getInternalServiceWorkerPathPrefix,
   getProjectPaths,
+  getProxyBuilder,
   getServicesBuilders,
   getWorkspacePackagePaths,
   getWorkspaces,
@@ -126,6 +129,7 @@ var import_detect_instrumentation = require("./detect-instrumentation");
   packageManagers,
   resolveAllConfiguredServicesV2,
   resolveConfiguredServiceV2,
+  validateProxyConfig,
   validateServiceConfigV2,
   workspaceManagers,
   ...require("./monorepos/get-monorepo-default-settings")

package/dist/services/utils.js

@@ -177,7 +177,7 @@ async function readVercelConfig(fs) {
       };
     }
   }
-  const hasVercelToml = process.env.VERCEL_TOML_CONFIG_ENABLED === "1" && await fs.hasPath("vercel.toml");
+  const hasVercelToml = await fs.hasPath("vercel.toml");
   if (hasVercelToml) {
     try {
       const { parse: tomlParse } = await import("smol-toml");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/fs-detectors",
-  "version": "6.13.2",
+  "version": "6.14.0",
   "description": "Vercel filesystem detectors",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,10 +20,10 @@
     "minimatch": "3.1.2",
     "semver": "6.3.1",
     "smol-toml": "1.5.2",
-    "@vercel/routing-utils": "6.4.0",
+    "@vercel/build-utils": "13.36.0",
+    "@vercel/frameworks": "3.30.7",
     "@vercel/error-utils": "2.2.0",
-    "@vercel/build-utils": "13.34.0",
-    "@vercel/frameworks": "3.30.7"
+    "@vercel/routing-utils": "6.4.0"
   },
   "devDependencies": {
     "@types/glob": "7.2.0",