@netlify/plugin-nextjs 4.41.3 → 5.0.0-beta.0

package/lib/helpers/analysis.js

@@ -1,115 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractConfigFromFile = exports.validateConfigValue = exports.isEdgeConfig = void 0;
-const fs_1 = __importStar(require("fs"));
-const pathe_1 = require("pathe");
-const utils_1 = require("./utils");
-const isEdgeConfig = (config) => ['experimental-edge', 'edge'].includes(config);
-exports.isEdgeConfig = isEdgeConfig;
-const validateConfigValue = (config, apiFilePath) => {
-    if (config.type === "experimental-scheduled" /* ApiRouteType.SCHEDULED */) {
-        if (!config.schedule) {
-            console.error(`Invalid config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}: schedule is required when type is "${"experimental-scheduled" /* ApiRouteType.SCHEDULED */}"`);
-            return false;
-        }
-        if ((0, exports.isEdgeConfig)(config.runtime)) {
-            console.error(`Invalid config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}: edge runtime is not supported for scheduled functions`);
-            return false;
-        }
-        return true;
-    }
-    if (!config.type || config.type === "experimental-background" /* ApiRouteType.BACKGROUND */) {
-        if (config.schedule) {
-            console.error(`Invalid config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}: schedule is not allowed unless type is "${"experimental-scheduled" /* ApiRouteType.SCHEDULED */}"`);
-            return false;
-        }
-        if (config.type && (0, exports.isEdgeConfig)(config.runtime)) {
-            console.error(`Invalid config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}: edge runtime is not supported for background functions`);
-            return false;
-        }
-        return true;
-    }
-    console.error(`Invalid config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}: type ${config.type} is not supported`);
-    return false;
-};
-exports.validateConfigValue = validateConfigValue;
-let extractConstValue;
-let parseModule;
-let hasWarnedAboutNextVersion = false;
-/**
- * Uses Next's swc static analysis to extract the config values from a file.
- */
-const extractConfigFromFile = async (apiFilePath, appDir) => {
-    if (!apiFilePath || !(0, fs_1.existsSync)(apiFilePath)) {
-        return {};
-    }
-    const extractConstValueModulePath = (0, utils_1.findModuleFromBase)({
-        paths: [appDir],
-        candidates: ['next/dist/build/analysis/extract-const-value'],
-    });
-    const parseModulePath = (0, utils_1.findModuleFromBase)({
-        paths: [appDir],
-        candidates: ['next/dist/build/analysis/parse-module'],
-    });
-    if (!extractConstValueModulePath || !parseModulePath) {
-        if (!hasWarnedAboutNextVersion) {
-            console.log("This version of Next.js doesn't support advanced API routes. Skipping...");
-            hasWarnedAboutNextVersion = true;
-        }
-        // Old Next.js version
-        return {};
-    }
-    if (!extractConstValue && extractConstValueModulePath) {
-        // eslint-disable-next-line import/no-dynamic-require
-        extractConstValue = require(extractConstValueModulePath);
-    }
-    if (!parseModule && parseModulePath) {
-        // eslint-disable-next-line prefer-destructuring, @typescript-eslint/no-var-requires, import/no-dynamic-require
-        parseModule = require(parseModulePath).parseModule;
-    }
-    const { extractExportedConstValue, UnsupportedValueError } = extractConstValue;
-    const fileContent = await fs_1.default.promises.readFile(apiFilePath, 'utf8');
-    // No need to parse if there's no "config"
-    if (!fileContent.includes('config')) {
-        return {};
-    }
-    const ast = await parseModule(apiFilePath, fileContent);
-    let config;
-    try {
-        config = extractExportedConstValue(ast, 'config');
-    }
-    catch (error) {
-        if (UnsupportedValueError && error instanceof UnsupportedValueError) {
-            console.warn(`Unsupported config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}`);
-        }
-        return {};
-    }
-    if ((0, exports.validateConfigValue)(config, apiFilePath)) {
-        return config;
-    }
-    throw new Error(`Unsupported config value in ${(0, pathe_1.relative)(process.cwd(), apiFilePath)}`);
-};
-exports.extractConfigFromFile = extractConfigFromFile;

package/lib/helpers/cache.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveCache = exports.restoreCache = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const utils_1 = require("./utils");
-const findDistDir = (publish) => {
-    // In normal operation, the dist dir is the same as the publish dir
-    if (!(0, utils_1.shouldSkip)()) {
-        return publish;
-    }
-    // In this situation, the user has disabled the next-runtime, which means that they might be using next export,
-    // so we'll look in a few places to find the site root. This allows us to find the .next directory.
-    for (const root of [(0, path_1.resolve)(publish, '..'), (0, path_1.resolve)(publish, '..', '..')]) {
-        if ((0, fs_1.existsSync)((0, path_1.join)(root, 'next.config.js'))) {
-            return (0, path_1.join)(root, '.next');
-        }
-    }
-    return null;
-};
-const restoreCache = async ({ cache, publish }) => {
-    const distDir = findDistDir(publish);
-    if (!distDir) {
-        return;
-    }
-    if (await cache.restore((0, path_1.join)(distDir, 'cache'))) {
-        console.log('Next.js cache restored.');
-    }
-    else {
-        console.log('No Next.js cache to restore.');
-    }
-};
-exports.restoreCache = restoreCache;
-const saveCache = async ({ cache, publish }) => {
-    const distDir = findDistDir(publish);
-    if (!distDir) {
-        return;
-    }
-    if (await cache.save((0, path_1.join)(distDir, 'cache'))) {
-        console.log('Next.js cache saved.');
-    }
-    else {
-        console.log('No Next.js cache to save.');
-    }
-};
-exports.saveCache = saveCache;

package/lib/helpers/compiler.js

@@ -1,119 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.watchForMiddlewareChanges = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const esbuild_1 = require("@netlify/esbuild");
-const chokidar_1 = require("chokidar");
-// For more information on Next.js middleware, see https://nextjs.org/docs/advanced-features/middleware
-// These are the locations that a middleware file can exist in a Next.js application
-// If other possible locations are added by Next.js, they should be added here.
-const MIDDLEWARE_FILE_LOCATIONS = [
-    'middleware.js',
-    'middleware.ts',
-    'src/middleware.js',
-    'src/middleware.ts',
-];
-const toFileList = (watched) => Object.entries(watched).flatMap(([dir, files]) => files.map((file) => (0, path_1.join)(dir, file)));
-/**
- * Compile the middleware file using esbuild
- */
-const buildMiddlewareFile = async (entryPoints, base) => {
-    try {
-        await (0, esbuild_1.build)({
-            entryPoints,
-            outfile: (0, path_1.join)(base, '.netlify', 'middleware.js'),
-            bundle: true,
-            format: 'esm',
-            target: 'esnext',
-            absWorkingDir: base,
-            external: ['next/dist/compiled/@vercel/og'],
-        });
-    }
-    catch (error) {
-        console.error(error.toString());
-    }
-};
-/**
- * We only compile middleware if there's exactly one file. If there's more than one, we log a warning and don't compile.
- */
-const shouldFilesBeCompiled = (watchedFiles, isFirstRun) => {
-    if (watchedFiles.length === 0) {
-        if (!isFirstRun) {
-            // Only log on subsequent builds, because having it on first build makes it seem like a warning, when it's a normal state
-            console.log('No middleware found');
-        }
-        return false;
-    }
-    if (watchedFiles.length > 1) {
-        console.log('Multiple middleware files found:');
-        console.log(watchedFiles.join('\n'));
-        console.log('This is not supported.');
-        return false;
-    }
-    return true;
-};
-const updateWatchedFiles = async (watcher, base, isFirstRun = false) => {
-    try {
-        // Start by deleting the old file. If we error out, we don't want to leave the old file around
-        await fs_1.promises.unlink((0, path_1.join)(base, '.netlify', 'middleware.js'));
-    }
-    catch {
-        // Ignore, because it's fine if it didn't exist
-    }
-    // The list of watched files is an object with the directory as the key and an array of files as the value.
-    // We need to flatten this into a list of files
-    const watchedFiles = toFileList(watcher.getWatched());
-    if (!shouldFilesBeCompiled(watchedFiles, isFirstRun)) {
-        watcher.emit('build');
-        return;
-    }
-    console.log(`${isFirstRun ? 'Building' : 'Rebuilding'} middleware ${watchedFiles[0]}...`);
-    await buildMiddlewareFile(watchedFiles, base);
-    console.log('...done');
-    watcher.emit('build');
-};
-/**
- * Watch for changes to the middleware file location. When a change is detected, recompile the middleware file.
- *
- * @param base The base directory to watch
- * @returns a file watcher and a promise that resolves when the initial scan is complete.
- */
-const watchForMiddlewareChanges = (base) => {
-    const watcher = (0, chokidar_1.watch)(MIDDLEWARE_FILE_LOCATIONS, {
-        // Try and ensure renames just emit one event
-        atomic: true,
-        // Don't emit for every watched file, just once after the scan is done
-        ignoreInitial: true,
-        cwd: base,
-    });
-    watcher
-        .on('change', (path) => {
-        console.log(`File ${path} has been changed`);
-        updateWatchedFiles(watcher, base);
-    })
-        .on('add', (path) => {
-        console.log(`File ${path} has been added`);
-        updateWatchedFiles(watcher, base);
-    })
-        .on('unlink', (path) => {
-        console.log(`File ${path} has been removed`);
-        updateWatchedFiles(watcher, base);
-    });
-    return {
-        watcher,
-        isReady: new Promise((resolve) => {
-            watcher.on('ready', async () => {
-                console.log('Initial scan for middleware file complete. Ready for changes.');
-                // This only happens on the first scan
-                await updateWatchedFiles(watcher, base, true);
-                console.log('Ready');
-                resolve();
-            });
-        }),
-        nextBuild: () => new Promise((resolve) => {
-            watcher.once('build', resolve);
-        }),
-    };
-};
-exports.watchForMiddlewareChanges = watchForMiddlewareChanges;

package/lib/helpers/config.js

@@ -1,192 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCustomHeaders = exports.configureHandlerFunctions = exports.hasManuallyAddedModule = exports.resolveModuleRoot = exports.updateRequiredServerFiles = exports.getRequiredServerFiles = exports.getNextConfig = void 0;
-const destr_1 = __importDefault(require("destr"));
-const fs_extra_1 = require("fs-extra");
-const pathe_1 = require("pathe");
-const slash_1 = __importDefault(require("slash"));
-const constants_1 = require("../constants");
-const utils_1 = require("./utils");
-const ROUTES_MANIFEST_FILE = 'routes-manifest.json';
-const defaultFailBuild = (message, { error }) => {
-    throw new Error(`${message}\n${error && error.stack}`);
-};
-const getNextConfig = async function getNextConfig({ publish, failBuild = defaultFailBuild, }) {
-    try {
-        const { config, appDir, ignore } = await (0, fs_extra_1.readJSON)((0, pathe_1.join)(publish, 'required-server-files.json'));
-        if (!config) {
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            return failBuild('Error loading your Next config');
-        }
-        const routesManifest = await (0, fs_extra_1.readJSON)((0, pathe_1.join)(publish, ROUTES_MANIFEST_FILE));
-        // If you need access to other manifest files, you can add them here as well
-        return { ...config, appDir, ignore, routesManifest };
-    }
-    catch (error) {
-        return failBuild('Error loading your Next config', { error });
-    }
-};
-exports.getNextConfig = getNextConfig;
-/**
- * Returns all of the NextJS configuration stored within 'required-server-files.json'
- * To update the configuration within this file, use the 'updateRequiredServerFiles' method.
- */
-const getRequiredServerFiles = async (publish) => {
-    const configFile = (0, pathe_1.join)(publish, 'required-server-files.json');
-    return await (0, fs_extra_1.readJSON)(configFile);
-};
-exports.getRequiredServerFiles = getRequiredServerFiles;
-/**
- * Writes a modified configuration object to 'required-server-files.json'.
- * To get the full configuration, use the 'getRequiredServerFiles' method.
- */
-const updateRequiredServerFiles = async (publish, modifiedConfig) => {
-    const configFile = (0, pathe_1.join)(publish, 'required-server-files.json');
-    await (0, fs_extra_1.writeJSON)(configFile, modifiedConfig);
-};
-exports.updateRequiredServerFiles = updateRequiredServerFiles;
-const resolveModuleRoot = (moduleName, paths = [process.cwd()]) => {
-    try {
-        return (0, pathe_1.dirname)((0, pathe_1.relative)(process.cwd(), require.resolve(`${moduleName}/package.json`, { paths })));
-    }
-    catch {
-        return null;
-    }
-};
-exports.resolveModuleRoot = resolveModuleRoot;
-const DEFAULT_EXCLUDED_MODULES = ['sharp', 'electron'];
-const hasManuallyAddedModule = ({ netlifyConfig, moduleName, }) => 
-/* eslint-disable camelcase */
-Object.values(netlifyConfig.functions).some(({ included_files = [] }) => included_files.some((inc) => inc.includes(`node_modules/${moduleName}`)));
-exports.hasManuallyAddedModule = hasManuallyAddedModule;
-/* eslint-enable camelcase */
-/**
- * Transforms `/api/shows/[id].js` into `/api/shows/*id*.js`,
- * so that the file `[id].js` is matched correctly.
- */
-const escapeGlob = (path) => path.replace(/\[/g, '*').replace(/]/g, '*');
-const configureHandlerFunctions = async ({ netlifyConfig, publish, ignore = [], apiLambdas, ssrLambdas, splitApiRoutes, }) => {
-    var _a;
-    const config = await (0, exports.getRequiredServerFiles)(publish);
-    const files = config.files || [];
-    const cssFilesToInclude = files.filter((f) => f.startsWith(`${publish}/static/css/`));
-    if (!(0, destr_1.default)(process.env.DISABLE_IPX)) {
-        (_a = netlifyConfig.functions)[constants_1.IMAGE_FUNCTION_NAME] || (_a[constants_1.IMAGE_FUNCTION_NAME] = {});
-        netlifyConfig.functions[constants_1.IMAGE_FUNCTION_NAME].node_bundler = 'nft';
-    }
-    // If the user has manually added the module to included_files, then don't exclude it
-    const excludedModules = DEFAULT_EXCLUDED_MODULES.filter((moduleName) => !(0, exports.hasManuallyAddedModule)({ netlifyConfig, moduleName }));
-    const configureFunction = (functionName) => {
-        var _a, _b;
-        (_a = netlifyConfig.functions)[functionName] || (_a[functionName] = { included_files: [], external_node_modules: [] });
-        netlifyConfig.functions[functionName].node_bundler = 'nft';
-        (_b = netlifyConfig.functions[functionName]).included_files || (_b.included_files = []);
-        netlifyConfig.functions[functionName].included_files.push('.env', '.env.local', '.env.production', '.env.production.local', './public/locales/**', './next-i18next.config.js', `${publish}/server/**`, `${publish}/serverless/**`, `${publish}/*.json`, `${publish}/BUILD_ID`, `${publish}/static/chunks/webpack-middleware*.js`, `!${publish}/server/**/*.js.nft.json`, `!${publish}/server/**/*.map`, '!**/node_modules/@next/swc*/**/*', ...cssFilesToInclude, ...ignore.map((path) => `!${(0, slash_1.default)(path)}`));
-        const nextRoot = (0, exports.resolveModuleRoot)('next');
-        if (nextRoot) {
-            netlifyConfig.functions[functionName].included_files.push(`!${nextRoot}/dist/server/lib/squoosh/**/*.wasm`, `!${nextRoot}/dist/next-server/server/lib/squoosh/**/*.wasm`, `!${nextRoot}/dist/compiled/webpack/bundle4.js`, `!${nextRoot}/dist/compiled/webpack/bundle5.js`);
-            // on Next 13.5+ there is no longer statically analyzable import to styled-jsx/style
-            // so lambda fails to bundle it. Next require hooks actually try to resolve it
-            // and fail if it is not bundled, so we forcefully add it to lambda.
-            const styledJsxRoot = (0, exports.resolveModuleRoot)('styled-jsx', [(0, pathe_1.join)(process.cwd(), nextRoot)]);
-            if (styledJsxRoot) {
-                const styledJsxStyleModulePath = (0, pathe_1.join)(styledJsxRoot, 'style.js');
-                netlifyConfig.functions[functionName].included_files.push(styledJsxStyleModulePath);
-            }
-        }
-        excludedModules.forEach((moduleName) => {
-            const moduleRoot = (0, exports.resolveModuleRoot)(moduleName);
-            if (moduleRoot) {
-                netlifyConfig.functions[functionName].included_files.push(`!${moduleRoot}/**/*`);
-            }
-        });
-    };
-    const configureLambda = (lambda) => {
-        var _a, _b;
-        const { functionName, includedFiles } = lambda;
-        (_a = netlifyConfig.functions)[functionName] || (_a[functionName] = { included_files: [] });
-        netlifyConfig.functions[functionName].node_bundler = 'none';
-        (_b = netlifyConfig.functions[functionName]).included_files || (_b.included_files = []);
-        netlifyConfig.functions[functionName].included_files.push(...includedFiles.map(escapeGlob));
-    };
-    if (ssrLambdas.length === 0) {
-        configureFunction(constants_1.HANDLER_FUNCTION_NAME);
-        configureFunction(constants_1.ODB_FUNCTION_NAME);
-    }
-    else {
-        ssrLambdas.forEach(configureLambda);
-    }
-    if (splitApiRoutes) {
-        apiLambdas.forEach(configureLambda);
-    }
-    else {
-        configureFunction('_api_*');
-    }
-};
-exports.configureHandlerFunctions = configureHandlerFunctions;
-const buildHeader = (buildHeaderParams) => {
-    const { path, headers } = buildHeaderParams;
-    return {
-        for: path,
-        values: headers.reduce((builtHeaders, { key, value }) => {
-            builtHeaders[key] = value;
-            return builtHeaders;
-        }, {}),
-    };
-};
-// Replace the pattern :path* at the end of a path with * since it's a named splat which the Netlify
-// configuration does not support.
-const sanitizePath = (path) => path.replace(/:[^*/]+\*$/, '*');
-/**
- * Persist Next.js custom headers to the Netlify configuration so the headers work with static files
- * See {@link https://nextjs.org/docs/api-reference/next.config.js/headers} for more information on custom
- * headers in Next.js
- *
- * @param nextConfig - The Next.js configuration
- * @param netlifyHeaders - Existing headers that are already configured in the Netlify configuration
- */
-const generateCustomHeaders = (nextConfig, netlifyHeaders = []) => {
-    var _a;
-    // The routesManifest is the contents of the routes-manifest.json file which will already contain the generated
-    // header paths which take locales and base path into account since this runs after the build. The routes-manifest.json
-    // file is located at demos/default/.next/routes-manifest.json once you've build the demo site.
-    const { routesManifest: { headers: customHeaders = [] }, i18n, } = nextConfig;
-    // Skip `has` based custom headers as they have more complex dynamic conditional header logic
-    // that currently isn't supported by the Netlify configuration.
-    // Also, this type of dynamic header logic is most likely not for SSG pages.
-    for (const { source, headers, locale: localeEnabled } of customHeaders.filter((customHeader) => !customHeader.has)) {
-        // Explicitly checking false to make the check simpler.
-        // Locale specific paths are excluded only if localeEnabled is false. There is no true value for localeEnabled. It's either
-        // false or undefined, where undefined means it's true.
-        //
-        // Again, the routesManifest has already been generated taking locales into account, but the check is required
-        // so  the paths can be properly set in the Netlify configuration.
-        const useLocale = ((_a = i18n === null || i18n === void 0 ? void 0 : i18n.locales) === null || _a === void 0 ? void 0 : _a.length) > 0 && localeEnabled !== false;
-        if (useLocale) {
-            const { locales } = i18n;
-            // escape the locale strings to match the way Next writes the routes-manifest.json file
-            const joinedLocales = locales.map((locale) => (0, utils_1.escapeStringRegexp)(locale)).join('|');
-            /**
-             *  converts e.g.
-             *  /:nextInternalLocale(en|fr)/some-path
-             *  to a path for each locale
-             *  /en/some-path and /fr/some-path as well as /some-path (default locale)
-             */
-            const defaultLocalePath = sanitizePath(source).replace(`/:nextInternalLocale(${joinedLocales})`, '');
-            netlifyHeaders.push(buildHeader({ path: defaultLocalePath, headers }));
-            for (const locale of locales) {
-                const path = sanitizePath(source).replace(`:nextInternalLocale(${joinedLocales})`, locale);
-                netlifyHeaders.push(buildHeader({ path, headers }));
-            }
-        }
-        else {
-            const path = sanitizePath(source);
-            netlifyHeaders.push(buildHeader({ path, headers }));
-        }
-    }
-};
-exports.generateCustomHeaders = generateCustomHeaders;

package/lib/helpers/dev.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.onPreDev = void 0;
-const path_1 = require("path");
-const execa_1 = __importDefault(require("execa"));
-const edge_1 = require("./edge");
-// The types haven't been updated yet
-const onPreDev = async ({ constants, netlifyConfig }) => {
-    var _a;
-    const base = (_a = netlifyConfig.build.base) !== null && _a !== void 0 ? _a : process.cwd();
-    await (0, edge_1.writeDevEdgeFunction)(constants);
-    // Don't await this or it will never finish
-    execa_1.default.node((0, path_1.resolve)(__dirname, '..', '..', 'lib', 'helpers', 'middlewareWatcher.js'), [base, process.env.NODE_ENV === 'test' ? '--once' : ''], {
-        stdio: 'inherit',
-    });
-};
-exports.onPreDev = onPreDev;