@netlify/plugin-nextjs 4.14.2 → 4.17.1-runtime.0

package/lib/helpers/cache.js

@@ -9,7 +9,7 @@ const findDistDir = (publish) => {
     if (!(0, utils_1.shouldSkip)()) {
         return publish;
     }
-    // In this situation, the user has disabled the plugin, which means that they might be using next export,
+    // 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'))) {

package/lib/helpers/files.js

@@ -229,6 +229,7 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, basePath, }) => {
     }
 };
 exports.moveStaticPages = moveStaticPages;
+const PATCH_WARNING = `/* File patched by Netlify */`;
 /**
  * Attempt to patch a source file, preserving a backup
  */
@@ -237,7 +238,11 @@ const patchFile = async ({ file, replacements, }) => {
         console.warn('File was not found');
         return false;
     }
-    const content = await (0, fs_extra_1.readFile)(file, 'utf8');
+    let content = await (0, fs_extra_1.readFile)(file, 'utf8');
+    // If the file has already been patched, patch the backed-up original instead
+    if (content.includes(PATCH_WARNING) && (0, fs_extra_1.existsSync)(`${file}.orig`)) {
+        content = await (0, fs_extra_1.readFile)(`${file}.orig`, 'utf8');
+    }
     const newContent = replacements.reduce((acc, [from, to]) => {
         if (acc.includes(to)) {
             console.log('Already patched. Skipping.');
@@ -250,7 +255,7 @@ const patchFile = async ({ file, replacements, }) => {
         return false;
     }
     await (0, fs_extra_1.writeFile)(`${file}.orig`, content);
-    await (0, fs_extra_1.writeFile)(file, newContent);
+    await (0, fs_extra_1.writeFile)(file, `${newContent}\n${PATCH_WARNING}`);
     console.log('Done');
     return true;
 };

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, remotePatterns, }) => {
+const setupImageFunction = async ({ constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC = constants_1.DEFAULT_FUNCTIONS_SRC }, imageconfig = {}, netlifyConfig, basePath, remotePatterns, responseHeaders, }) => {
     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);
@@ -49,6 +49,7 @@ const setupImageFunction = async ({ constants: { INTERNAL_FUNCTIONS_SRC, FUNCTIO
         ...imageconfig,
         basePath: [basePath, constants_1.IMAGE_FUNCTION_NAME].join('/'),
         remotePatterns,
+        responseHeaders,
     });
     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/helpers/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNextAuthInstalled = exports.findModuleFromBase = exports.shouldSkip = exports.getPreviewRewrites = exports.getApiRewrites = exports.redirectsForNextRouteWithData = exports.redirectsForNextRoute = exports.isApiRoute = exports.routeToDataRoute = exports.netlifyRoutesForNextRouteWithData = exports.toNetlifyRoute = void 0;
+exports.getCustomImageResponseHeaders = exports.isNextAuthInstalled = exports.findModuleFromBase = exports.shouldSkip = exports.getPreviewRewrites = exports.getApiRewrites = exports.redirectsForNextRouteWithData = exports.redirectsForNextRoute = exports.isApiRoute = exports.routeToDataRoute = exports.netlifyRoutesForNextRouteWithData = exports.toNetlifyRoute = void 0;
 const globby_1 = __importDefault(require("globby"));
 const pathe_1 = require("pathe");
 const constants_1 = require("../constants");
@@ -136,7 +136,7 @@ const findModuleFromBase = ({ paths, candidates }) => {
 exports.findModuleFromBase = findModuleFromBase;
 const isNextAuthInstalled = () => {
     try {
-        // eslint-disable-next-line import/no-unassigned-import, import/no-unresolved, n/no-missing-require
+        // eslint-disable-next-line import/no-unassigned-import, import/no-extraneous-dependencies, n/no-extraneous-require
         require('next-auth');
         return true;
     }
@@ -146,3 +146,12 @@ const isNextAuthInstalled = () => {
     }
 };
 exports.isNextAuthInstalled = isNextAuthInstalled;
+const getCustomImageResponseHeaders = (headers) => {
+    const customImageResponseHeaders = headers.find((header) => { var _a; return (_a = header.for) === null || _a === void 0 ? void 0 : _a.startsWith('/_next/image/'); });
+    if (customImageResponseHeaders) {
+        return customImageResponseHeaders === null || customImageResponseHeaders === void 0 ? void 0 : customImageResponseHeaders.values;
+    }
+    return null;
+};
+exports.getCustomImageResponseHeaders = getCustomImageResponseHeaders;
+/* eslint-enable max-lines */

package/lib/helpers/verification.js

@@ -42,7 +42,7 @@ const verifyNetlifyBuildVersion = ({ IS_LOCAL, NETLIFY_BUILD_VERSION, failBuild,
     // We check for build version because that's what's available to us, but prompt about the cli because that's what they can upgrade
     if (IS_LOCAL && !(0, semver_1.satisfies)(NETLIFY_BUILD_VERSION, REQUIRED_BUILD_VERSION, { includePrerelease: true })) {
         return failBuild((0, outdent_1.outdent) `
-      This version of the Essential Next.js plugin requires netlify-cli@6.12.4 or higher. Please upgrade and try again.
+      This version of the Next Runtime requires netlify-cli@6.12.4 or higher. Please upgrade and try again.
       You can do this by running: "npm install -g netlify-cli@latest" or "yarn global add netlify-cli@latest"
     `);
     }
@@ -136,7 +136,7 @@ exports.checkZipSize = checkZipSize;
 const getProblematicUserRewrites = ({ redirects, basePath, }) => {
     const userRewrites = [];
     for (const redirect of redirects) {
-        // This is the first of the plugin-generated redirects so we can stop checking
+        // This is the first of the runtime-generated redirects so we can stop checking
         if (redirect.from === `${basePath}/_next/static/*` && redirect.to === `/static/:splat` && redirect.status === 200) {
             break;
         }
@@ -159,7 +159,7 @@ const warnForProblematicUserRewrites = ({ redirects, basePath, }) => {
         return;
     }
     console.log((0, chalk_1.yellowBright)((0, outdent_1.outdent) `
-      You have the following Netlify rewrite${userRewrites.length === 1 ? '' : 's'} that might cause conflicts with the Next.js plugin:
+      You have the following Netlify rewrite${userRewrites.length === 1 ? '' : 's'} that might cause conflicts with the Next.js Runtime:
 
       ${(0, chalk_1.reset)(userRewrites.map(({ from, to, status }) => `- ${from} ${to} ${status}`).join('\n'))}
 

package/lib/index.js

@@ -20,7 +20,7 @@ const plugin = {
         const { publish } = netlifyConfig.build;
         if ((0, utils_1.shouldSkip)()) {
             await (0, cache_1.restoreCache)({ cache, publish });
-            console.log('Not running Essential Next.js plugin');
+            console.log('Not running Next Runtime');
             if ((0, fs_extra_1.existsSync)((0, path_1.join)(constants.INTERNAL_FUNCTIONS_SRC, constants_1.HANDLER_FUNCTION_NAME))) {
                 console.log(`Please ensure you remove any generated functions from ${constants.INTERNAL_FUNCTIONS_SRC}`);
             }
@@ -80,6 +80,7 @@ const plugin = {
             netlifyConfig,
             basePath,
             remotePatterns: experimentalRemotePatterns,
+            responseHeaders: (0, utils_1.getCustomImageResponseHeaders)(netlifyConfig.headers),
         });
         await (0, redirects_1.generateRedirects)({
             netlifyConfig,
@@ -108,7 +109,7 @@ const plugin = {
         await (0, cache_1.saveCache)({ cache, publish });
         if ((0, utils_1.shouldSkip)()) {
             status.show({
-                title: 'Essential Next.js plugin did not run',
+                title: 'Next Runtime did not run',
                 summary: `Next cache was stored, but all other functions were skipped because ${process.env.NETLIFY_NEXT_PLUGIN_SKIP
                     ? `NETLIFY_NEXT_PLUGIN_SKIP is set`
                     : `NEXT_PLUGIN_FORCE_RUN is set to ${process.env.NEXT_PLUGIN_FORCE_RUN}`}`,
@@ -122,7 +123,6 @@ const plugin = {
         (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;

package/lib/templates/getHandler.js

@@ -81,6 +81,13 @@ const makeHandler = (conf, app, pageRoot, staticManifest = [], mode = 'ssr') =>
         // Next expects to be able to parse the query from the URL
         const query = new URLSearchParams(event.queryStringParameters).toString();
         event.path = query ? `${event.path}?${query}` : event.path;
+        const graphToken = event.netlifyGraphToken;
+        if (graphToken && requestMode !== 'ssr') {
+            // Prefix with underscore to help us determine the origin of the token
+            // allows us to write better error messages
+            // eslint-disable-next-line no-underscore-dangle
+            process.env._NETLIFY_GRAPH_TOKEN = graphToken;
+        }
         const { headers, ...result } = await getBridge(event).launcher(event, context);
         // Convert all headers to multiValueHeaders
         const multiValueHeaders = getMultiValueHeaders(headers);

package/lib/templates/ipx.js

@@ -8,5 +8,6 @@ exports.handler = (0, ipx_1.createIPXHandler)({
     basePath: imageconfig_json_1.basePath,
     domains: imageconfig_json_1.domains,
     remotePatterns: imageconfig_json_1.remotePatterns,
+    responseHeaders: imageconfig_json_1.responseHeaders,
 });
 /* eslint-enable n/no-missing-import, import/no-unresolved, @typescript-eslint/ban-ts-comment  */

package/manifest.yml

@@ -1 +1 @@
-name: netlify-plugin-nextjs-experimental
+name: netlify-next-runtime-experimental

package/package.json

@@ -1,28 +1,16 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.14.2",
+  "version": "4.17.1-runtime.0",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
     "lib/**/*",
     "src/templates/edge/*",
-    "manifest.yml",
-    "middleware.js"
+    "manifest.yml"
   ],
-  "typesVersions": {
-    "*": {
-      "middleware": [
-        "dist-types/middleware"
-      ]
-    }
-  },
-  "exports": {
-    ".": "./lib/index.js",
-    "./middleware": "./lib/middleware/index.js"
-  },
   "dependencies": {
-    "@netlify/functions": "^1.0.0",
-    "@netlify/ipx": "^1.2.0",
+    "@netlify/functions": "^1.2.0",
+    "@netlify/ipx": "^1.2.2",
     "@vercel/node-bridge": "^2.1.0",
     "chalk": "^4.1.2",
     "fs-extra": "^10.0.0",
@@ -40,7 +28,7 @@
   },
   "devDependencies": {
     "@delucis/if-env": "^1.1.2",
-    "@netlify/build": "^27.11.2",
+    "@netlify/build": "^27.14.0",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",
     "@types/node": "^17.0.25",
@@ -63,15 +51,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/netlify/netlify-plugin-nextjs.git"
+    "url": "git+https://github.com/netlify/next-runtime.git"
   },
-  "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
-    "url": "https://github.com/netlify/netlify-plugin-nextjs/issues"
+    "url": "https://github.com/netlify/next-runtime/issues"
   },
-  "homepage": "https://github.com/netlify/netlify-plugin-nextjs#readme",
+  "homepage": "https://github.com/netlify/next-runtime#readme",
   "engines": {
     "node": ">=12.0.0"
   }
-}
+}

package/lib/middleware/html-rewriter.js

@@ -1,4 +0,0 @@
-"use strict";
-/* eslint-disable max-classes-per-file */
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-enable max-classes-per-file */

package/lib/middleware/index.js

@@ -1,19 +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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./response"), exports);
-__exportStar(require("./request"), exports);
-__exportStar(require("./html-rewriter"), exports);

package/lib/middleware/request.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MiddlewareRequest = void 0;
-const server_1 = require("next/server");
-const response_1 = require("./response");
-/**
- * Supercharge your Next middleware with Netlify Edge Functions
- */
-class MiddlewareRequest extends Request {
-    constructor(nextRequest) {
-        super(nextRequest);
-        this.nextRequest = nextRequest;
-        if (!('Deno' in globalThis)) {
-            throw new Error('MiddlewareRequest only works in a Netlify Edge Function environment');
-        }
-        const requestId = nextRequest.headers.get('x-nf-request-id');
-        if (!requestId) {
-            throw new Error('Missing x-nf-request-id header');
-        }
-        const requestContext = globalThis.NFRequestContextMap.get(requestId);
-        if (!requestContext) {
-            throw new Error(`Could not find request context for request id ${requestId}`);
-        }
-        this.context = requestContext.context;
-        this.originalRequest = requestContext.request;
-    }
-    // Add the headers to the original request, which will be passed to the origin
-    applyHeaders() {
-        this.headers.forEach((value, name) => {
-            this.originalRequest.headers.set(name, value);
-        });
-    }
-    async next() {
-        this.applyHeaders();
-        const response = await this.context.next();
-        return new response_1.MiddlewareResponse(response);
-    }
-    rewrite(destination, init) {
-        if (typeof destination === 'string' && destination.startsWith('/')) {
-            destination = new URL(destination, this.url);
-        }
-        this.applyHeaders();
-        return server_1.NextResponse.rewrite(destination, init);
-    }
-    get headers() {
-        return this.nextRequest.headers;
-    }
-    get cookies() {
-        return this.nextRequest.cookies;
-    }
-    get geo() {
-        return this.nextRequest.geo;
-    }
-    get ip() {
-        return this.nextRequest.ip;
-    }
-    get nextUrl() {
-        return this.nextRequest.url;
-    }
-    get url() {
-        return this.nextRequest.url.toString();
-    }
-}
-exports.MiddlewareRequest = MiddlewareRequest;

package/lib/middleware/response.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MiddlewareResponse = void 0;
-const server_1 = require("next/server");
-// A NextResponse that wraps the Netlify origin response
-// We can't pass it through directly, because Next disallows returning a response body
-class MiddlewareResponse extends server_1.NextResponse {
-    constructor(originResponse) {
-        super();
-        this.originResponse = originResponse;
-        // These are private in Node when compiling, but we access them in Deno at runtime
-        Object.defineProperty(this, 'dataTransforms', {
-            value: [],
-            enumerable: false,
-            writable: false,
-        });
-        Object.defineProperty(this, 'elementHandlers', {
-            value: [],
-            enumerable: false,
-            writable: false,
-        });
-    }
-    /**
-     * Transform the page props before they are passed to the client.
-     * This works for both HTML pages and JSON data
-     */
-    transformData(transform) {
-        // The transforms are evaluated after the middleware is returned
-        this.dataTransforms.push(transform);
-    }
-    /**
-     * Rewrite the response HTML with the given selector and handlers
-     */
-    rewriteHTML(selector, handlers) {
-        this.elementHandlers.push([selector, handlers]);
-    }
-    /**
-     * Sets the value of a page prop.
-     * @see transformData if you need more control
-     */
-    setPageProp(key, value) {
-        this.transformData((props) => {
-            props.pageProps || (props.pageProps = {});
-            props.pageProps[key] = value;
-            return props;
-        });
-    }
-    /**
-     * Replace the text of the given element. Takes either a string or a function
-     * that is passed the original string and returns new new string.
-     * @see rewriteHTML for more control
-     */
-    replaceText(selector, valueOrReplacer) {
-        // If it's a string then our job is simpler, because we don't need to collect the current text
-        if (typeof valueOrReplacer === 'string') {
-            this.rewriteHTML(selector, {
-                text(textChunk) {
-                    if (textChunk.lastInTextNode) {
-                        textChunk.replace(valueOrReplacer);
-                    }
-                    else {
-                        textChunk.remove();
-                    }
-                },
-            });
-        }
-        else {
-            let text = '';
-            this.rewriteHTML(selector, {
-                text(textChunk) {
-                    text += textChunk.text;
-                    // We're finished, so we can replace the text
-                    if (textChunk.lastInTextNode) {
-                        textChunk.replace(valueOrReplacer(text));
-                    }
-                    else {
-                        // Remove the chunk, because we'll be adding it back later
-                        textChunk.remove();
-                    }
-                },
-            });
-        }
-    }
-    get headers() {
-        var _a;
-        // If we have the origin response, we should use its headers
-        return ((_a = this.originResponse) === null || _a === void 0 ? void 0 : _a.headers) || super.headers;
-    }
-}
-exports.MiddlewareResponse = MiddlewareResponse;