@vercel/build-utils 2.12.3-canary.9 → 2.13.0

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

@@ -0,0 +1,173 @@
+"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,
+ * return the new Builder. Otherwise an "Exclusion Condition"
+ * was hit so return `null` builder with a `reason` for exclusion.
+ */
+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 nextVersion = deps['next'];
+        if (!nextVersion) {
+            return {
+                metadata,
+                fsApiBuilder: null,
+                reason: `Detected Next.js in Project Settings but missing \`next\` package.json dependencies. Please run \`npm i next\`.`,
+            };
+        }
+        // TODO: Read version from lockfile instead of package.json
+        if (nextVersion !== 'latest' && nextVersion !== 'canary') {
+            const fixedVersion = semver_1.default.valid(semver_1.default.coerce(nextVersion) || '');
+            if (!fixedVersion || !semver_1.default.gte(fixedVersion, '12.0.0')) {
+                return {
+                    metadata,
+                    fsApiBuilder: null,
+                    reason: `Detected legacy Next.js version "${nextVersion}" in package.json. Please run \`npm i next@latest\` to upgrade.`,
+                };
+            }
+        }
+    }
+    if (!hasDotOutput) {
+        // TODO: Read version from lockfile instead of package.json
+        const vercelCliVersion = deps['vercel'];
+        if (vercelCliVersion &&
+            vercelCliVersion !== 'latest' &&
+            vercelCliVersion !== 'canary') {
+            const fixedVersion = semver_1.default.valid(semver_1.default.coerce(vercelCliVersion) || '');
+            // TODO: we might want to use '24.0.0' once its released
+            if (!fixedVersion || !semver_1.default.gte(fixedVersion, '23.1.3-canary.68')) {
+                return {
+                    metadata,
+                    fsApiBuilder: null,
+                    reason: `Detected legacy Vercel CLI version "${vercelCliVersion}" in package.json. Please run \`npm i vercel@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/fs/glob.js

@@ -8,6 +8,7 @@ const assert_1 = __importDefault(require("assert"));
 const glob_1 = __importDefault(require("glob"));
 const util_1 = require("util");
 const fs_extra_1 = require("fs-extra");
+const normalize_path_1 = require("./normalize-path");
 const file_fs_ref_1 = __importDefault(require("../file-fs-ref"));
 const vanillaGlob = util_1.promisify(glob_1.default);
 async function glob(pattern, opts, mountpoint) {
@@ -31,7 +32,7 @@ async function glob(pattern, opts, mountpoint) {
     options.dot = true;
     const files = await vanillaGlob(pattern, options);
     for (const relativePath of files) {
-        const fsPath = path_1.default.join(options.cwd, relativePath).replace(/\\/g, '/');
+        const fsPath = normalize_path_1.normalizePath(path_1.default.join(options.cwd, relativePath));
         let stat = options.statCache[fsPath];
         assert_1.default(stat, `statCache does not contain value for ${relativePath} (resolved to ${fsPath})`);
         const isSymlink = options.symlinks[fsPath];

package/dist/fs/normalize-path.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Convert Windows separators to Unix separators.
+ */
+export declare function normalizePath(p: string): string;

package/dist/fs/normalize-path.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePath = void 0;
+const isWin = process.platform === 'win32';
+/**
+ * Convert Windows separators to Unix separators.
+ */
+function normalizePath(p) {
+    return isWin ? p.replace(/\\/g, '/') : p;
+}
+exports.normalizePath = normalizePath;

package/dist/get-ignore-filter.d.ts

@@ -0,0 +1 @@
+export default function (downloadPath: string, rootDirectory?: string | undefined): Promise<(p: string) => any>;

package/dist/get-ignore-filter.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const ignore_1 = __importDefault(require("ignore"));
+function isCodedError(error) {
+    return (error !== null &&
+        error !== undefined &&
+        error.code !== undefined);
+}
+function clearRelative(s) {
+    return s.replace(/(\n|^)\.\//g, '$1');
+}
+async function default_1(downloadPath, rootDirectory) {
+    const readFile = async (p) => {
+        try {
+            return await fs_extra_1.default.readFile(p, 'utf8');
+        }
+        catch (error) {
+            if (error.code === 'ENOENT' ||
+                (error instanceof Error && error.message.includes('ENOENT'))) {
+                return undefined;
+            }
+            throw error;
+        }
+    };
+    const vercelIgnorePath = path_1.default.join(downloadPath, rootDirectory || '', '.vercelignore');
+    const nowIgnorePath = path_1.default.join(downloadPath, rootDirectory || '', '.nowignore');
+    const ignoreContents = [];
+    try {
+        ignoreContents.push(...(await Promise.all([readFile(vercelIgnorePath), readFile(nowIgnorePath)])).filter(Boolean));
+    }
+    catch (error) {
+        if (isCodedError(error) && error.code === 'ENOTDIR') {
+            console.log(`Warning: Cannot read ignore file from ${vercelIgnorePath}`);
+        }
+        else {
+            throw error;
+        }
+    }
+    if (ignoreContents.length === 2) {
+        throw new Error('Cannot use both a `.vercelignore` and `.nowignore` file. Please delete the `.nowignore` file.');
+    }
+    if (ignoreContents.length === 0) {
+        return () => false;
+    }
+    const ignoreFilter = ignore_1.default().add(clearRelative(ignoreContents[0]));
+    return function (p) {
+        // we should not ignore now.json and vercel.json if it asked to.
+        // we depend on these files for building the app with sourceless
+        if (p === 'now.json' || p === 'vercel.json')
+            return false;
+        return ignoreFilter.test(p).ignored;
+    };
+}
+exports.default = default_1;

package/dist/index.d.ts

@@ -12,11 +12,15 @@ import { getLatestNodeVersion, getDiscontinuedNodeVersions } from './fs/node-ver
 import streamToBuffer from './fs/stream-to-buffer';
 import shouldServe from './should-serve';
 import debug from './debug';
-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, };
+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';
+export { normalizePath } from './fs/normalize-path';
+export { _experimental_convertRuntimeToPlugin, _experimental_updateFunctionsManifest, _experimental_updateRoutesManifest, } from './convert-runtime-to-plugin';
 export * from './schemas';
 export * from './types';
 export * from './errors';