@netlify/vite-plugin-react-router 3.0.0 → 3.1.0-next.0

package/README.md

@@ -10,33 +10,28 @@ To deploy a React Router 7+ site to Netlify, install this package:
 npm install @netlify/vite-plugin-react-router
 ```
 
-It's also recommended (but not required) to use the
-[Netlify Vite plugin](https://www.npmjs.com/package/@netlify/vite-plugin), which provides full Netlify platform
-emulation directly in your local dev server:
-
-```sh
-npm install --save-dev @netlify/vite-plugin
-```
-
-and include the Netlify plugin in your `vite.config.ts`:
+Then include the Netlify plugin in your `vite.config.ts`:
 
 ```typescript
 import { reactRouter } from '@react-router/dev/vite'
 import { defineConfig } from 'vite'
 import tsconfigPaths from 'vite-tsconfig-paths'
 import netlifyReactRouter from '@netlify/vite-plugin-react-router' // <- add this
-import netlify from '@netlify/vite-plugin' // <- add this (optional)
 
 export default defineConfig({
   plugins: [
     reactRouter(),
     tsconfigPaths(),
     netlifyReactRouter(), // <- add this
-    netlify(), // <- add this (optional)
   ],
 })
 ```
 
+> [!NOTE]
+>
+> This plugin automatically includes [`@netlify/vite-plugin`](https://npmx.dev/@netlify/vite-plugin), which provides
+> full Netlify platform emulation directly in your local dev server.
+
 Your app is ready to [deploy to Netlify](https://docs.netlify.com/deploy/create-deploys/).
 
 ### Deploying to Edge Functions
@@ -53,7 +48,6 @@ export default defineConfig({
     reactRouter(),
     tsconfigPaths(),
     netlifyReactRouter({ edge: true }), // <- deploy to Edge Functions
-    netlify(),
   ],
 })
 ```
@@ -88,7 +82,6 @@ export default defineConfig({
       edge: true,
       excludedPaths: ['/ping', '/api/*', '/webhooks/*'],
     }),
-    netlify(),
   ],
 })
 ```
@@ -159,12 +152,6 @@ export default function Example() {
 }
 ```
 
-> [!IMPORTANT]
->
-> Note that in local development, `netlifyRouterContext` requires Netlify platform emulation, which is provided
-> seamlessly by [`@netlify/vite-plugin`](https://www.npmjs.com/package/@netlify/vite-plugin) (or Netlify CLI - up to
-> you).
-
 ### Middleware context
 
 React Router introduced a stable middleware feature in 7.9.0.
@@ -193,9 +180,3 @@ export default function Home() {
   return <h1>Hello world</h1>
 }
 ```
-
-> [!IMPORTANT]
->
-> Note that in local development, `netlifyRouterContext` requires Netlify platform emulation, which is provided
-> seamlessly by [`@netlify/vite-plugin`](https://www.npmjs.com/package/@netlify/vite-plugin) (or Netlify CLI - up to
-> you).

package/dist/index.d.mts

@@ -21,6 +21,6 @@ interface NetlifyPluginOptions {
      */
     excludedPaths?: string[];
 }
-declare function netlifyPlugin(options?: NetlifyPluginOptions): Plugin;
+declare function netlifyPlugin(options?: NetlifyPluginOptions): Plugin[];
 
 export { netlifyPlugin as default };

package/dist/index.d.ts

@@ -60,6 +60,6 @@ interface NetlifyPluginOptions {
      */
     excludedPaths?: string[];
 }
-declare function netlifyPlugin(options?: NetlifyPluginOptions): Plugin;
+declare function netlifyPlugin(options?: NetlifyPluginOptions): Plugin[];
 
 export { type GetLoadContextFunction, type RequestHandler, createRequestHandler, netlifyPlugin as default, netlifyRouterContext };

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name2 in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -109,11 +119,12 @@ function createRequestHandler({
 var import_promises = require("fs/promises");
 var import_node_path2 = require("path");
 var import_posix = require("path/posix");
+var import_vite_plugin = __toESM(require("@netlify/vite-plugin"));
 var import_tinyglobby = require("tinyglobby");
 
 // package.json
 var name = "@netlify/vite-plugin-react-router";
-var version = "3.0.0";
+var version = "3.1.0-next.0";
 
 // src/lib/rollup.ts
 var import_node_path = require("path");
@@ -149,6 +160,26 @@ var FUNCTION_HANDLER_MODULE_ID = "virtual:netlify-server";
 var RESOLVED_FUNCTION_HANDLER_MODULE_ID = `\0${FUNCTION_HANDLER_MODULE_ID}`;
 var SERVER_ENTRY_MODULE_ID = "virtual:netlify-server-entry";
 var toPosixPath = (path) => path.split(import_node_path2.sep).join(import_posix.sep);
+var ALLOWED_USER_EDGE_FUNCTION_HANDLER_FILENAMES = [
+  "server.ts",
+  "server.mts",
+  "server.cts",
+  "server.mjs",
+  "server.cjs",
+  "server.js"
+];
+var findUserEdgeFunctionHandlerFile = async (root) => {
+  for (const filename of ALLOWED_USER_EDGE_FUNCTION_HANDLER_FILENAMES) {
+    try {
+      await (0, import_promises.access)((0, import_node_path2.join)(root, filename));
+      return filename;
+    } catch {
+    }
+  }
+  throw new Error(
+    "Your Hydrogen site must include a `server.ts` (or js/mjs/cjs/mts/cts) file at the root to deploy to Netlify. See https://github.com/netlify/hydrogen-template."
+  );
+};
 var FUNCTION_HANDLER = (
   /* js */
   `
@@ -207,7 +238,8 @@ function netlifyPlugin(options = {}) {
   let resolvedConfig;
   let isProductionSsrBuild = false;
   let currentCommand;
-  return {
+  let isHydrogenSite = false;
+  const reactRouterPlugin = {
     name: "vite-plugin-netlify-react-router",
     config(_config, { command, isSsrBuild }) {
       currentCommand = command;
@@ -222,7 +254,9 @@ function netlifyPlugin(options = {}) {
             rollupOptions: {
               input: mergedInput,
               output: {
-                entryFileNames: "[name].js"
+                // NOTE: must use function syntax here to work around Shopify CLI reading
+                // the config value literally (i.e. trying to stat `[name].js` as a filename).
+                entryFileNames: () => "[name].js"
               }
             }
           },
@@ -243,6 +277,11 @@ function netlifyPlugin(options = {}) {
       }
     },
     async resolveId(source, importer, options2) {
+      if (isHydrogenSite && edge) {
+        if (source === FUNCTION_HANDLER_MODULE_ID || source === SERVER_ENTRY_MODULE_ID) {
+          return;
+        }
+      }
       if (source === FUNCTION_HANDLER_MODULE_ID) {
         return RESOLVED_FUNCTION_HANDLER_MODULE_ID;
       }
@@ -263,8 +302,18 @@ function netlifyPlugin(options = {}) {
         return edge ? EDGE_FUNCTION_HANDLER : FUNCTION_HANDLER;
       }
     },
-    async configResolved(config) {
-      resolvedConfig = config;
+    configResolved: {
+      order: "pre",
+      async handler(config) {
+        resolvedConfig = config;
+        isHydrogenSite = config.plugins.some((plugin) => plugin.name === "hydrogen:main");
+        if (isHydrogenSite && edge && isProductionSsrBuild) {
+          const userServerFile = await findUserEdgeFunctionHandlerFile(config.root);
+          if (config.build?.rollupOptions?.input && typeof config.build.rollupOptions.input === "object" && !Array.isArray(config.build.rollupOptions.input)) {
+            config.build.rollupOptions.input[FUNCTION_HANDLER_CHUNK] = userServerFile;
+          }
+        }
+      }
     },
     // See https://rollupjs.org/plugin-development/#writebundle.
     async writeBundle() {
@@ -300,6 +349,7 @@ function netlifyPlugin(options = {}) {
       }
     }
   };
+  return [reactRouterPlugin, ...(0, import_vite_plugin.default)()];
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -5,14 +5,15 @@ import {
 import "./chunk-J5PMA2AP.mjs";
 
 // src/plugin.ts
-import { mkdir, writeFile } from "node:fs/promises";
+import { access, mkdir, writeFile } from "node:fs/promises";
 import { dirname, join, relative, resolve, sep } from "node:path";
 import { sep as posixSep } from "node:path/posix";
+import netlifyVitePlugin from "@netlify/vite-plugin";
 import { glob } from "tinyglobby";
 
 // package.json
 var name = "@netlify/vite-plugin-react-router";
-var version = "3.0.0";
+var version = "3.1.0-next.0";
 
 // src/lib/rollup.ts
 import { basename, extname } from "node:path";
@@ -48,6 +49,26 @@ var FUNCTION_HANDLER_MODULE_ID = "virtual:netlify-server";
 var RESOLVED_FUNCTION_HANDLER_MODULE_ID = `\0${FUNCTION_HANDLER_MODULE_ID}`;
 var SERVER_ENTRY_MODULE_ID = "virtual:netlify-server-entry";
 var toPosixPath = (path) => path.split(sep).join(posixSep);
+var ALLOWED_USER_EDGE_FUNCTION_HANDLER_FILENAMES = [
+  "server.ts",
+  "server.mts",
+  "server.cts",
+  "server.mjs",
+  "server.cjs",
+  "server.js"
+];
+var findUserEdgeFunctionHandlerFile = async (root) => {
+  for (const filename of ALLOWED_USER_EDGE_FUNCTION_HANDLER_FILENAMES) {
+    try {
+      await access(join(root, filename));
+      return filename;
+    } catch {
+    }
+  }
+  throw new Error(
+    "Your Hydrogen site must include a `server.ts` (or js/mjs/cjs/mts/cts) file at the root to deploy to Netlify. See https://github.com/netlify/hydrogen-template."
+  );
+};
 var FUNCTION_HANDLER = (
   /* js */
   `
@@ -106,7 +127,8 @@ function netlifyPlugin(options = {}) {
   let resolvedConfig;
   let isProductionSsrBuild = false;
   let currentCommand;
-  return {
+  let isHydrogenSite = false;
+  const reactRouterPlugin = {
     name: "vite-plugin-netlify-react-router",
     config(_config, { command, isSsrBuild }) {
       currentCommand = command;
@@ -121,7 +143,9 @@ function netlifyPlugin(options = {}) {
             rollupOptions: {
               input: mergedInput,
               output: {
-                entryFileNames: "[name].js"
+                // NOTE: must use function syntax here to work around Shopify CLI reading
+                // the config value literally (i.e. trying to stat `[name].js` as a filename).
+                entryFileNames: () => "[name].js"
               }
             }
           },
@@ -142,6 +166,11 @@ function netlifyPlugin(options = {}) {
       }
     },
     async resolveId(source, importer, options2) {
+      if (isHydrogenSite && edge) {
+        if (source === FUNCTION_HANDLER_MODULE_ID || source === SERVER_ENTRY_MODULE_ID) {
+          return;
+        }
+      }
       if (source === FUNCTION_HANDLER_MODULE_ID) {
         return RESOLVED_FUNCTION_HANDLER_MODULE_ID;
       }
@@ -162,8 +191,18 @@ function netlifyPlugin(options = {}) {
         return edge ? EDGE_FUNCTION_HANDLER : FUNCTION_HANDLER;
       }
     },
-    async configResolved(config) {
-      resolvedConfig = config;
+    configResolved: {
+      order: "pre",
+      async handler(config) {
+        resolvedConfig = config;
+        isHydrogenSite = config.plugins.some((plugin) => plugin.name === "hydrogen:main");
+        if (isHydrogenSite && edge && isProductionSsrBuild) {
+          const userServerFile = await findUserEdgeFunctionHandlerFile(config.root);
+          if (config.build?.rollupOptions?.input && typeof config.build.rollupOptions.input === "object" && !Array.isArray(config.build.rollupOptions.input)) {
+            config.build.rollupOptions.input[FUNCTION_HANDLER_CHUNK] = userServerFile;
+          }
+        }
+      }
     },
     // See https://rollupjs.org/plugin-development/#writebundle.
     async writeBundle() {
@@ -199,6 +238,7 @@ function netlifyPlugin(options = {}) {
       }
     }
   };
+  return [reactRouterPlugin, ...netlifyVitePlugin()];
 }
 export {
   createRequestHandler,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/vite-plugin-react-router",
-  "version": "3.0.0",
+  "version": "3.1.0-next.0",
   "description": "React Router 7+ Vite plugin for Netlify",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -52,8 +52,9 @@
   },
   "homepage": "https://github.com/netlify/remix-compute#readme",
   "dependencies": {
-    "@netlify/edge-functions": "^3.0.3",
-    "@netlify/functions": "^5.1.2",
+    "@netlify/edge-functions": "^3.0.4",
+    "@netlify/functions": "^5.1.3",
+    "@netlify/vite-plugin": "^2.10.11",
     "isbot": "^5.1.25",
     "tinyglobby": "^0.2.10"
   },