@vercel/build-utils 2.12.3-canary.42 → 2.12.3-canary.43

package/dist/detect-builders.d.ts

@@ -1,5 +1,5 @@
 import { Route } from '@vercel/routing-utils';
-import { PackageJson, Builder, BuilderFunctions } from './types';
+import { PackageJson, Builder, BuilderFunctions, ProjectSettings } from './types';
 interface ErrorResponse {
     code: string;
     message: string;
@@ -10,14 +10,7 @@ interface Options {
     tag?: 'canary' | 'latest' | string;
     functions?: BuilderFunctions;
     ignoreBuildScript?: boolean;
-    projectSettings?: {
-        framework?: string | null;
-        devCommand?: string | null;
-        installCommand?: string | null;
-        buildCommand?: string | null;
-        outputDirectory?: string | null;
-        createdAt?: number;
-    };
+    projectSettings?: ProjectSettings;
     cleanUrls?: boolean;
     trailingSlash?: boolean;
     featHandleMiss?: boolean;

package/dist/detect-file-system-api.d.ts

@@ -0,0 +1,33 @@
+import type { Builder, BuilderFunctions, PackageJson, ProjectSettings } from './types';
+interface Metadata {
+    plugins: string[];
+    hasDotOutput: boolean;
+    hasMiddleware: boolean;
+}
+/**
+ * If the Deployment can be built with the new File System API,
+ * we'll return the new Builder here, otherwise return `null`.
+ */
+export declare function detectFileSystemAPI({ files, projectSettings, builders, vercelConfig, pkg, tag, enableFlag, }: {
+    files: {
+        [relPath: string]: any;
+    };
+    projectSettings: ProjectSettings;
+    builders: Builder[];
+    vercelConfig: {
+        builds?: Builder[];
+        functions?: BuilderFunctions;
+    } | null | undefined;
+    pkg: PackageJson | null | undefined;
+    tag: string | undefined;
+    enableFlag: boolean | undefined;
+}): Promise<{
+    metadata: Metadata;
+    fsApiBuilder: Builder;
+    reason: null;
+} | {
+    metadata: Metadata;
+    fsApiBuilder: null;
+    reason: string;
+}>;
+export {};

package/dist/detect-file-system-api.js

@@ -0,0 +1,155 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectFileSystemAPI = void 0;
+const semver_1 = __importDefault(require("semver"));
+const _1 = require("./");
+const enableFileSystemApiFrameworks = new Set(['solidstart']);
+/**
+ * If the Deployment can be built with the new File System API,
+ * we'll return the new Builder here, otherwise return `null`.
+ */
+async function detectFileSystemAPI({ files, projectSettings, builders, vercelConfig, pkg, tag, enableFlag = false, }) {
+    const framework = projectSettings.framework || '';
+    const deps = Object.assign({}, pkg === null || pkg === void 0 ? void 0 : pkg.dependencies, pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies);
+    const plugins = Object.keys(deps).filter(dep => dep.startsWith('vercel-plugin-'));
+    const hasDotOutput = Object.keys(files).some(file => file.startsWith('.output/'));
+    const hasMiddleware = Boolean(files['_middleware.js'] || files['_middleware.ts']);
+    const metadata = {
+        plugins,
+        hasDotOutput,
+        hasMiddleware,
+    };
+    const isEnabled = enableFlag ||
+        hasMiddleware ||
+        hasDotOutput ||
+        enableFileSystemApiFrameworks.has(framework);
+    if (!isEnabled) {
+        return { metadata, fsApiBuilder: null, reason: 'Flag not enabled.' };
+    }
+    if ((vercelConfig === null || vercelConfig === void 0 ? void 0 : vercelConfig.builds) && vercelConfig.builds.length > 0) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `builds` in vercel.json. Please remove it in favor of CLI plugins.',
+        };
+    }
+    if (Object.values((vercelConfig === null || vercelConfig === void 0 ? void 0 : vercelConfig.functions) || {}).some(fn => !!fn.runtime)) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `functions.runtime` in vercel.json. Please remove it in favor of CLI plugins.',
+        };
+    }
+    if (process.env.HUGO_VERSION) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `HUGO_VERSION` environment variable. Please remove it.',
+        };
+    }
+    if (process.env.ZOLA_VERSION) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `ZOLA_VERSION` environment variable. Please remove it.',
+        };
+    }
+    if (process.env.GUTENBERG_VERSION) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `GUTENBERG_VERSION` environment variable. Please remove it.',
+        };
+    }
+    const invalidBuilder = builders.find(({ use }) => {
+        const valid = _1.isOfficialRuntime('go', use) ||
+            _1.isOfficialRuntime('python', use) ||
+            _1.isOfficialRuntime('ruby', use) ||
+            _1.isOfficialRuntime('node', use) ||
+            _1.isOfficialRuntime('next', use) ||
+            _1.isOfficialRuntime('static', use) ||
+            _1.isOfficialRuntime('static-build', use);
+        return !valid;
+    });
+    if (invalidBuilder) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: `Detected \`${invalidBuilder.use}\` in vercel.json. Please remove it in favor of CLI plugins.`,
+        };
+    }
+    for (const lang of ['go', 'python', 'ruby']) {
+        for (const { use } of builders) {
+            const plugin = 'vercel-plugin-' + lang;
+            if (_1.isOfficialRuntime(lang, use) && !deps[plugin]) {
+                return {
+                    metadata,
+                    fsApiBuilder: null,
+                    reason: `Detected \`${lang}\` Serverless Function usage without plugin \`${plugin}\`. Please run \`npm i ${plugin}\`.`,
+                };
+            }
+        }
+    }
+    if (framework === 'nuxtjs' ||
+        framework === 'sveltekit' ||
+        framework === 'redwoodjs') {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: `Detected framework \`${framework}\` that only supports legacy File System API. Please contact the framework author.`,
+        };
+    }
+    if (framework === 'nextjs' && !hasDotOutput) {
+        // Use the old pipeline if a custom output directory was specified for Next.js
+        // because `vercel build` cannot ensure that the directory will be in the same
+        // location as `.output`, which can break imports (not just nft.json files).
+        if (projectSettings === null || projectSettings === void 0 ? void 0 : projectSettings.outputDirectory) {
+            return {
+                metadata,
+                fsApiBuilder: null,
+                reason: `Detected Next.js with Output Directory \`${projectSettings.outputDirectory}\` override. Please change it back to the default.`,
+            };
+        }
+        const versionRange = deps['next'];
+        if (!versionRange) {
+            return {
+                metadata,
+                fsApiBuilder: null,
+                reason: `Detected Next.js in Project Settings but missing \`next\` package.json dependencies. Please run \`npm i next\`.`,
+            };
+        }
+        // TODO: We'll need to check the lockfile if one is present.
+        if (versionRange !== 'latest' && versionRange !== 'canary') {
+            const fixedVersion = semver_1.default.valid(semver_1.default.coerce(versionRange) || '');
+            if (!fixedVersion || !semver_1.default.gte(fixedVersion, '12.0.0')) {
+                return {
+                    metadata,
+                    fsApiBuilder: null,
+                    reason: `Detected legacy Next.js version "${versionRange}" in package.json. Please run \`npm i next@latest\` to upgrade.`,
+                };
+            }
+        }
+    }
+    const frontendBuilder = builders.find(({ use }) => _1.isOfficialRuntime('next', use) ||
+        _1.isOfficialRuntime('static', use) ||
+        _1.isOfficialRuntime('static-build', use));
+    const config = (frontendBuilder === null || frontendBuilder === void 0 ? void 0 : frontendBuilder.config) || {};
+    const withTag = tag ? `@${tag}` : '';
+    const fsApiBuilder = {
+        use: `@vercelruntimes/file-system-api${withTag}`,
+        src: '**',
+        config: {
+            ...config,
+            fileSystemAPI: true,
+            framework: config.framework || framework || null,
+            projectSettings,
+            hasMiddleware,
+            hasDotOutput,
+        },
+    };
+    return { metadata, fsApiBuilder, reason: null };
+}
+exports.detectFileSystemAPI = detectFileSystemAPI;

package/dist/index.d.ts

@@ -16,6 +16,7 @@ import debug from './debug';
 import getIgnoreFilter from './get-ignore-filter';
 export { FileBlob, FileFsRef, FileRef, Lambda, createLambda, Prerender, download, DownloadedFiles, getWriteableDirectory, glob, GlobOptions, rename, execAsync, spawnAsync, getScriptName, installDependencies, runPackageJsonScript, execCommand, spawnCommand, walkParentDirs, getNodeBinPath, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, getNodeVersion, getLatestNodeVersion, getDiscontinuedNodeVersions, getSpawnOptions, streamToBuffer, shouldServe, debug, isSymbolicLink, getLambdaOptionsFromFunction, scanParentDirs, getIgnoreFilter, };
 export { detectBuilders, detectOutputDirectory, detectApiDirectory, detectApiExtensions, } from './detect-builders';
+export { detectFileSystemAPI } from './detect-file-system-api';
 export { detectFramework } from './detect-framework';
 export { DetectorFilesystem } from './detectors/filesystem';
 export { readConfigFile } from './fs/read-config-file';

package/dist/index.js

@@ -33839,6 +33839,169 @@ function sortFilesBySegmentCount(fileA, fileB) {
 }
 
 
+/***/ }),
+
+/***/ 1182:
+/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
+
+"use strict";
+
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.detectFileSystemAPI = void 0;
+const semver_1 = __importDefault(__webpack_require__(2879));
+const _1 = __webpack_require__(2855);
+const enableFileSystemApiFrameworks = new Set(['solidstart']);
+/**
+ * If the Deployment can be built with the new File System API,
+ * we'll return the new Builder here, otherwise return `null`.
+ */
+async function detectFileSystemAPI({ files, projectSettings, builders, vercelConfig, pkg, tag, enableFlag = false, }) {
+    const framework = projectSettings.framework || '';
+    const deps = Object.assign({}, pkg === null || pkg === void 0 ? void 0 : pkg.dependencies, pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies);
+    const plugins = Object.keys(deps).filter(dep => dep.startsWith('vercel-plugin-'));
+    const hasDotOutput = Object.keys(files).some(file => file.startsWith('.output/'));
+    const hasMiddleware = Boolean(files['_middleware.js'] || files['_middleware.ts']);
+    const metadata = {
+        plugins,
+        hasDotOutput,
+        hasMiddleware,
+    };
+    const isEnabled = enableFlag ||
+        hasMiddleware ||
+        hasDotOutput ||
+        enableFileSystemApiFrameworks.has(framework);
+    if (!isEnabled) {
+        return { metadata, fsApiBuilder: null, reason: 'Flag not enabled.' };
+    }
+    if ((vercelConfig === null || vercelConfig === void 0 ? void 0 : vercelConfig.builds) && vercelConfig.builds.length > 0) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `builds` in vercel.json. Please remove it in favor of CLI plugins.',
+        };
+    }
+    if (Object.values((vercelConfig === null || vercelConfig === void 0 ? void 0 : vercelConfig.functions) || {}).some(fn => !!fn.runtime)) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `functions.runtime` in vercel.json. Please remove it in favor of CLI plugins.',
+        };
+    }
+    if (process.env.HUGO_VERSION) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `HUGO_VERSION` environment variable. Please remove it.',
+        };
+    }
+    if (process.env.ZOLA_VERSION) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `ZOLA_VERSION` environment variable. Please remove it.',
+        };
+    }
+    if (process.env.GUTENBERG_VERSION) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: 'Detected `GUTENBERG_VERSION` environment variable. Please remove it.',
+        };
+    }
+    const invalidBuilder = builders.find(({ use }) => {
+        const valid = _1.isOfficialRuntime('go', use) ||
+            _1.isOfficialRuntime('python', use) ||
+            _1.isOfficialRuntime('ruby', use) ||
+            _1.isOfficialRuntime('node', use) ||
+            _1.isOfficialRuntime('next', use) ||
+            _1.isOfficialRuntime('static', use) ||
+            _1.isOfficialRuntime('static-build', use);
+        return !valid;
+    });
+    if (invalidBuilder) {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: `Detected \`${invalidBuilder.use}\` in vercel.json. Please remove it in favor of CLI plugins.`,
+        };
+    }
+    for (const lang of ['go', 'python', 'ruby']) {
+        for (const { use } of builders) {
+            const plugin = 'vercel-plugin-' + lang;
+            if (_1.isOfficialRuntime(lang, use) && !deps[plugin]) {
+                return {
+                    metadata,
+                    fsApiBuilder: null,
+                    reason: `Detected \`${lang}\` Serverless Function usage without plugin \`${plugin}\`. Please run \`npm i ${plugin}\`.`,
+                };
+            }
+        }
+    }
+    if (framework === 'nuxtjs' ||
+        framework === 'sveltekit' ||
+        framework === 'redwoodjs') {
+        return {
+            metadata,
+            fsApiBuilder: null,
+            reason: `Detected framework \`${framework}\` that only supports legacy File System API. Please contact the framework author.`,
+        };
+    }
+    if (framework === 'nextjs' && !hasDotOutput) {
+        // Use the old pipeline if a custom output directory was specified for Next.js
+        // because `vercel build` cannot ensure that the directory will be in the same
+        // location as `.output`, which can break imports (not just nft.json files).
+        if (projectSettings === null || projectSettings === void 0 ? void 0 : projectSettings.outputDirectory) {
+            return {
+                metadata,
+                fsApiBuilder: null,
+                reason: `Detected Next.js with Output Directory \`${projectSettings.outputDirectory}\` override. Please change it back to the default.`,
+            };
+        }
+        const versionRange = deps['next'];
+        if (!versionRange) {
+            return {
+                metadata,
+                fsApiBuilder: null,
+                reason: `Detected Next.js in Project Settings but missing \`next\` package.json dependencies. Please run \`npm i next\`.`,
+            };
+        }
+        // TODO: We'll need to check the lockfile if one is present.
+        if (versionRange !== 'latest' && versionRange !== 'canary') {
+            const fixedVersion = semver_1.default.valid(semver_1.default.coerce(versionRange) || '');
+            if (!fixedVersion || !semver_1.default.gte(fixedVersion, '12.0.0')) {
+                return {
+                    metadata,
+                    fsApiBuilder: null,
+                    reason: `Detected legacy Next.js version "${versionRange}" in package.json. Please run \`npm i next@latest\` to upgrade.`,
+                };
+            }
+        }
+    }
+    const frontendBuilder = builders.find(({ use }) => _1.isOfficialRuntime('next', use) ||
+        _1.isOfficialRuntime('static', use) ||
+        _1.isOfficialRuntime('static-build', use));
+    const config = (frontendBuilder === null || frontendBuilder === void 0 ? void 0 : frontendBuilder.config) || {};
+    const withTag = tag ? `@${tag}` : '';
+    const fsApiBuilder = {
+        use: `@vercelruntimes/file-system-api${withTag}`,
+        src: '**',
+        config: {
+            ...config,
+            fileSystemAPI: true,
+            framework: config.framework || framework || null,
+            projectSettings,
+            hasMiddleware,
+            hasDotOutput,
+        },
+    };
+    return { metadata, fsApiBuilder, reason: null };
+}
+exports.detectFileSystemAPI = detectFileSystemAPI;
+
+
 /***/ }),
 
 /***/ 5224:
@@ -35070,7 +35233,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getInputHash = exports.getPlatformEnv = exports.isStaticRuntime = exports.isOfficialRuntime = exports.updateRoutesManifest = exports.updateFunctionsManifest = exports.convertRuntimeToPlugin = exports.normalizePath = exports.readConfigFile = exports.DetectorFilesystem = exports.detectFramework = exports.detectApiExtensions = exports.detectApiDirectory = exports.detectOutputDirectory = exports.detectBuilders = exports.getIgnoreFilter = exports.scanParentDirs = exports.getLambdaOptionsFromFunction = exports.isSymbolicLink = exports.debug = exports.shouldServe = exports.streamToBuffer = exports.getSpawnOptions = exports.getDiscontinuedNodeVersions = exports.getLatestNodeVersion = exports.getNodeVersion = exports.runShellScript = exports.runPipInstall = exports.runBundleInstall = exports.runNpmInstall = exports.getNodeBinPath = exports.walkParentDirs = exports.spawnCommand = exports.execCommand = exports.runPackageJsonScript = exports.installDependencies = exports.getScriptName = exports.spawnAsync = exports.execAsync = exports.rename = exports.glob = exports.getWriteableDirectory = exports.download = exports.Prerender = exports.createLambda = exports.Lambda = exports.FileRef = exports.FileFsRef = exports.FileBlob = void 0;
+exports.getInputHash = exports.getPlatformEnv = exports.isStaticRuntime = exports.isOfficialRuntime = exports.updateRoutesManifest = exports.updateFunctionsManifest = exports.convertRuntimeToPlugin = exports.normalizePath = exports.readConfigFile = exports.DetectorFilesystem = exports.detectFramework = exports.detectFileSystemAPI = exports.detectApiExtensions = exports.detectApiDirectory = exports.detectOutputDirectory = exports.detectBuilders = exports.getIgnoreFilter = exports.scanParentDirs = exports.getLambdaOptionsFromFunction = exports.isSymbolicLink = exports.debug = exports.shouldServe = exports.streamToBuffer = exports.getSpawnOptions = exports.getDiscontinuedNodeVersions = exports.getLatestNodeVersion = exports.getNodeVersion = exports.runShellScript = exports.runPipInstall = exports.runBundleInstall = exports.runNpmInstall = exports.getNodeBinPath = exports.walkParentDirs = exports.spawnCommand = exports.execCommand = exports.runPackageJsonScript = exports.installDependencies = exports.getScriptName = exports.spawnAsync = exports.execAsync = exports.rename = exports.glob = exports.getWriteableDirectory = exports.download = exports.Prerender = exports.createLambda = exports.Lambda = exports.FileRef = exports.FileFsRef = exports.FileBlob = void 0;
 const crypto_1 = __webpack_require__(6417);
 const file_blob_1 = __importDefault(__webpack_require__(2397));
 exports.FileBlob = file_blob_1.default;
@@ -35127,6 +35290,8 @@ Object.defineProperty(exports, "detectBuilders", ({ enumerable: true, get: funct
 Object.defineProperty(exports, "detectOutputDirectory", ({ enumerable: true, get: function () { return detect_builders_1.detectOutputDirectory; } }));
 Object.defineProperty(exports, "detectApiDirectory", ({ enumerable: true, get: function () { return detect_builders_1.detectApiDirectory; } }));
 Object.defineProperty(exports, "detectApiExtensions", ({ enumerable: true, get: function () { return detect_builders_1.detectApiExtensions; } }));
+var detect_file_system_api_1 = __webpack_require__(1182);
+Object.defineProperty(exports, "detectFileSystemAPI", ({ enumerable: true, get: function () { return detect_file_system_api_1.detectFileSystemAPI; } }));
 var detect_framework_1 = __webpack_require__(5224);
 Object.defineProperty(exports, "detectFramework", ({ enumerable: true, get: function () { return detect_framework_1.detectFramework; } }));
 var filesystem_1 = __webpack_require__(461);

package/dist/types.d.ts

@@ -21,7 +21,7 @@ export interface Files {
 export interface Config {
     [key: string]: string | string[] | boolean | number | {
         [key: string]: string;
-    } | BuilderFunctions | undefined;
+    } | BuilderFunctions | ProjectSettings | undefined | null;
     maxLambdaSize?: string;
     includeFiles?: string | string[];
     excludeFiles?: string | string[];
@@ -35,11 +35,12 @@ export interface Config {
         [key: string]: string;
     };
     functions?: BuilderFunctions;
+    projectSettings?: ProjectSettings;
     outputDirectory?: string;
     installCommand?: string;
     buildCommand?: string;
     devCommand?: string;
-    framework?: string;
+    framework?: string | null;
     nodeVersion?: string;
 }
 export interface Meta {
@@ -305,3 +306,16 @@ export interface BuilderFunctions {
         excludeFiles?: string;
     };
 }
+export interface ProjectSettings {
+    framework?: string | null;
+    devCommand?: string | null;
+    installCommand?: string | null;
+    buildCommand?: string | null;
+    outputDirectory?: string | null;
+    rootDirectory?: string | null;
+    createdAt?: number;
+    autoExposeSystemEnvs?: boolean;
+    sourceFilesOutsideRootDirectory?: boolean;
+    directoryListing?: boolean;
+    gitForkProtection?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "2.12.3-canary.42",
+  "version": "2.12.3-canary.43",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",
@@ -49,5 +49,5 @@
     "typescript": "4.3.4",
     "yazl": "2.4.3"
   },
-  "gitHead": "d3ef240f6e01fff3d11d0499c9aaf892968748e3"
+  "gitHead": "01ea7b4b2a4acb47b6de5f593d9c33856caf4403"
 }