@netlify/plugin-nextjs 4.7.1 → 4.9.1

package/lib/helpers/config.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configureHandlerFunctions = exports.updateRequiredServerFiles = exports.getRequiredServerFiles = exports.getNextConfig = void 0;
+exports.generateCustomHeaders = exports.configureHandlerFunctions = exports.updateRequiredServerFiles = exports.getRequiredServerFiles = exports.getNextConfig = void 0;
 const fs_extra_1 = require("fs-extra");
 const pathe_1 = require("pathe");
 const slash_1 = __importDefault(require("slash"));
 const constants_1 = require("../constants");
+const ROUTES_MANIFEST_FILE = 'routes-manifest.json';
 const defaultFailBuild = (message, { error }) => {
     throw new Error(`${message}\n${error && error.stack}`);
 };
@@ -19,7 +20,9 @@ const getNextConfig = async function getNextConfig({ publish, failBuild = defaul
             // @ts-ignore
             return failBuild('Error loading your Next config');
         }
-        return { ...config, appDir, ignore };
+        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 });
@@ -77,3 +80,64 @@ const configureHandlerFunctions = ({ netlifyConfig, publish, ignore = [] }) => {
     });
 };
 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 NextJS 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;
+            const joinedLocales = locales.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/functions.js

@@ -40,7 +40,7 @@ const generatePagesResolver = async ({ constants: { INTERNAL_FUNCTIONS_SRC, FUNC
 };
 exports.generatePagesResolver = generatePagesResolver;
 // Move our next/image function into the correct functions directory
-const setupImageFunction = async ({ constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC = constants_1.DEFAULT_FUNCTIONS_SRC }, imageconfig = {}, netlifyConfig, basePath, }) => {
+const setupImageFunction = async ({ constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC = constants_1.DEFAULT_FUNCTIONS_SRC }, imageconfig = {}, netlifyConfig, basePath, remotePatterns, }) => {
     const functionsPath = INTERNAL_FUNCTIONS_SRC || FUNCTIONS_SRC;
     const functionName = `${constants_1.IMAGE_FUNCTION_NAME}.js`;
     const functionDirectory = (0, pathe_1.join)(functionsPath, constants_1.IMAGE_FUNCTION_NAME);
@@ -48,6 +48,7 @@ const setupImageFunction = async ({ constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIO
     await (0, fs_extra_1.writeJSON)((0, pathe_1.join)(functionDirectory, 'imageconfig.json'), {
         ...imageconfig,
         basePath: [basePath, constants_1.IMAGE_FUNCTION_NAME].join('/'),
+        remotePatterns,
     });
     await (0, fs_extra_1.copyFile)((0, pathe_1.join)(__dirname, '..', '..', 'lib', 'templates', 'ipx.js'), (0, pathe_1.join)(functionDirectory, functionName));
     const imagePath = imageconfig.path || '/_next/image';

package/lib/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable max-lines */
 const path_1 = require("path");
 const chalk_1 = require("chalk");
 const fs_extra_1 = require("fs-extra");
@@ -38,10 +39,14 @@ const plugin = {
         }
         const { publish } = netlifyConfig.build;
         (0, verification_1.checkNextSiteHasBuilt)({ publish, failBuild });
-        const { appDir, basePath, i18n, images, target, ignore, trailingSlash, outdir } = await (0, config_1.getNextConfig)({
+        let experimentalRemotePatterns = [];
+        const { appDir, basePath, i18n, images, target, ignore, trailingSlash, outdir, experimental } = await (0, config_1.getNextConfig)({
             publish,
             failBuild,
         });
+        if (experimental.images) {
+            experimentalRemotePatterns = experimental.images.remotePatterns || [];
+        }
         if ((0, utils_1.isNextAuthInstalled)()) {
             const config = await (0, config_1.getRequiredServerFiles)(publish);
             const userDefinedNextAuthUrl = config.config.env.NEXTAUTH_URL;
@@ -68,7 +73,13 @@ const plugin = {
             netlifyConfig,
             nextConfig: { basePath, i18n },
         });
-        await (0, functions_1.setupImageFunction)({ constants, imageconfig: images, netlifyConfig, basePath });
+        await (0, functions_1.setupImageFunction)({
+            constants,
+            imageconfig: images,
+            netlifyConfig,
+            basePath,
+            remotePatterns: experimentalRemotePatterns,
+        });
         await (0, redirects_1.generateRedirects)({
             netlifyConfig,
             nextConfig: { basePath, i18n, trailingSlash, appDir },
@@ -83,7 +94,7 @@ const plugin = {
             await (0, edge_1.updateConfig)(publish);
         }
     },
-    async onPostBuild({ netlifyConfig: { build: { publish }, redirects, }, utils: { status, cache, functions, build: { failBuild }, }, constants: { FUNCTIONS_DIST }, }) {
+    async onPostBuild({ netlifyConfig: { build: { publish }, redirects, headers, }, utils: { status, cache, functions, build: { failBuild }, }, constants: { FUNCTIONS_DIST }, }) {
         await (0, cache_1.saveCache)({ cache, publish });
         if ((0, utils_1.shouldSkip)()) {
             status.show({
@@ -96,10 +107,13 @@ const plugin = {
         }
         await (0, verification_1.checkForOldFunctions)({ functions });
         await (0, verification_1.checkZipSize)((0, path_1.join)(FUNCTIONS_DIST, `${constants_1.ODB_FUNCTION_NAME}.zip`));
-        const { basePath, appDir } = await (0, config_1.getNextConfig)({ publish, failBuild });
+        const nextConfig = await (0, config_1.getNextConfig)({ publish, failBuild });
+        const { basePath, appDir } = nextConfig;
+        (0, config_1.generateCustomHeaders)(nextConfig, headers);
         (0, verification_1.warnForProblematicUserRewrites)({ basePath, redirects });
         (0, verification_1.warnForRootRedirects)({ appDir });
         await (0, files_1.unpatchNextFiles)(basePath);
     },
 };
 module.exports = plugin;
+/* eslint-enable max-lines */

package/lib/templates/ipx.js

@@ -7,5 +7,6 @@ const imageconfig_json_1 = require("./imageconfig.json");
 exports.handler = (0, ipx_1.createIPXHandler)({
     basePath: imageconfig_json_1.basePath,
     domains: imageconfig_json_1.domains,
+    remotePatterns: imageconfig_json_1.remotePatterns,
 });
 /* eslint-enable node/no-missing-import, import/no-unresolved, @typescript-eslint/ban-ts-comment  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.7.1",
+  "version": "4.9.1",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -10,7 +10,7 @@
   ],
   "dependencies": {
     "@netlify/functions": "^1.0.0",
-    "@netlify/ipx": "^1.0.1",
+    "@netlify/ipx": "^1.1.0",
     "@vercel/node-bridge": "^2.1.0",
     "chalk": "^4.1.2",
     "fs-extra": "^10.0.0",
@@ -32,7 +32,7 @@
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",
     "@types/node": "^17.0.25",
-    "next": "^12.1.6",
+    "next": "^12.1.7-canary.33",
     "npm-run-all": "^4.1.5",
     "typescript": "^4.6.3"
   },

package/src/templates/edge/runtime.ts

@@ -34,7 +34,7 @@ export interface RequestData {
 
 const handler = async (req: Request, context: Context) => {
   const url = new URL(req.url)
-  if (url.pathname.startsWith('/_next/')) {
+  if (url.pathname.startsWith('/_next/static/')) {
     return
   }