@netlify/vite-plugin-react-router 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.0.1](https://github.com/netlify/remix-compute/compare/vite-plugin-react-router-v2.0.0...vite-plugin-react-router-v2.0.1) (2025-10-20)
+
+
+### Bug Fixes
+
+* populate value for Netlify React Router context in dev ([#550](https://github.com/netlify/remix-compute/issues/550)) ([8d2c9fd](https://github.com/netlify/remix-compute/commit/8d2c9fd21090ca063d99a9e7094393932d870801))
+
 ## [2.0.0](https://github.com/netlify/remix-compute/compare/vite-plugin-react-router-v1.0.1...vite-plugin-react-router-v2.0.0) (2025-10-16)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -3,27 +3,37 @@
 The React Router Adapter for Netlify allows you to deploy your [React Router](https://reactrouter.com) app to
 [Netlify Functions](https://docs.netlify.com/functions/overview/).
 
-To deploy a React Router 7+ site to Netlify, install this package:
-
 ## How to use
 
+To deploy a React Router 7+ site to Netlify, install this package:
+
 ```sh
 npm install --save-dev @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`:
 
 ```typescript
 import { reactRouter } from '@react-router/dev/vite'
 import { defineConfig } from 'vite'
 import tsconfigPaths from 'vite-tsconfig-paths'
-import netlifyPlugin from '@netlify/vite-plugin-react-router' // <- add this
+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(),
-    netlifyPlugin(), // <- add this
+    netlifyReactRouter(), // <- add this
+    netlify(), // <- add this (optional)
   ],
 })
 ```
@@ -76,6 +86,12 @@ 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.
@@ -103,3 +119,9 @@ 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

@@ -28,7 +28,7 @@ type RequestHandler = (request: Request, context: Context) => Promise<Response>;
  *
  * @example context.get(netlifyRouterContext).geo?.country?.name
  */
-declare const netlifyRouterContext: react_router.RouterContext<Context>;
+declare const netlifyRouterContext: react_router.RouterContext<Partial<Context>>;
 /**
  * Given a build and a callback to get the base loader context, this returns
  * a Netlify Function handler (https://docs.netlify.com/functions/overview/) which renders the

package/dist/index.d.ts

@@ -28,7 +28,7 @@ type RequestHandler = (request: Request, context: Context) => Promise<Response>;
  *
  * @example context.get(netlifyRouterContext).geo?.country?.name
  */
-declare const netlifyRouterContext: react_router.RouterContext<Context>;
+declare const netlifyRouterContext: react_router.RouterContext<Partial<Context>>;
 /**
  * Given a build and a callback to get the base loader context, this returns
  * a Netlify Function handler (https://docs.netlify.com/functions/overview/) which renders the

package/dist/index.js

@@ -28,7 +28,37 @@ module.exports = __toCommonJS(index_exports);
 
 // src/server.ts
 var import_react_router = require("react-router");
-var netlifyRouterContext = (0, import_react_router.createContext)();
+var netlifyRouterContext = (
+  // We must use a singleton because Remix contexts rely on referential equality.
+  // We can't hook into the request lifecycle in dev mode, so we use a Proxy to always read from the
+  // current `Netlify.context` value, which is always contextual to the in-flight request.
+  (0, import_react_router.createContext)(
+    new Proxy(
+      // Can't reference `Netlify.context` here because it isn't set outside of a request lifecycle
+      {},
+      {
+        get(_target, prop, receiver) {
+          return Reflect.get(Netlify.context ?? {}, prop, receiver);
+        },
+        set(_target, prop, value, receiver) {
+          return Reflect.set(Netlify.context ?? {}, prop, value, receiver);
+        },
+        has(_target, prop) {
+          return Reflect.has(Netlify.context ?? {}, prop);
+        },
+        deleteProperty(_target, prop) {
+          return Reflect.deleteProperty(Netlify.context ?? {}, prop);
+        },
+        ownKeys(_target) {
+          return Reflect.ownKeys(Netlify.context ?? {});
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+          return Reflect.getOwnPropertyDescriptor(Netlify.context ?? {}, prop);
+        }
+      }
+    )
+  )
+);
 function createRequestHandler({
   build,
   mode,
@@ -64,7 +94,7 @@ var import_posix = require("path/posix");
 
 // package.json
 var name = "@netlify/vite-plugin-react-router";
-var version = "2.0.0";
+var version = "2.0.1";
 
 // src/plugin.ts
 var NETLIFY_FUNCTIONS_DIR = ".netlify/v1/functions";

package/dist/index.mjs

@@ -4,7 +4,37 @@ import {
   RouterContextProvider,
   createRequestHandler as createReactRouterRequestHandler
 } from "react-router";
-var netlifyRouterContext = createContext();
+var netlifyRouterContext = (
+  // We must use a singleton because Remix contexts rely on referential equality.
+  // We can't hook into the request lifecycle in dev mode, so we use a Proxy to always read from the
+  // current `Netlify.context` value, which is always contextual to the in-flight request.
+  createContext(
+    new Proxy(
+      // Can't reference `Netlify.context` here because it isn't set outside of a request lifecycle
+      {},
+      {
+        get(_target, prop, receiver) {
+          return Reflect.get(Netlify.context ?? {}, prop, receiver);
+        },
+        set(_target, prop, value, receiver) {
+          return Reflect.set(Netlify.context ?? {}, prop, value, receiver);
+        },
+        has(_target, prop) {
+          return Reflect.has(Netlify.context ?? {}, prop);
+        },
+        deleteProperty(_target, prop) {
+          return Reflect.deleteProperty(Netlify.context ?? {}, prop);
+        },
+        ownKeys(_target) {
+          return Reflect.ownKeys(Netlify.context ?? {});
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+          return Reflect.getOwnPropertyDescriptor(Netlify.context ?? {}, prop);
+        }
+      }
+    )
+  )
+);
 function createRequestHandler({
   build,
   mode,
@@ -40,7 +70,7 @@ import { sep as posixSep } from "node:path/posix";
 
 // package.json
 var name = "@netlify/vite-plugin-react-router";
-var version = "2.0.0";
+var version = "2.0.1";
 
 // src/plugin.ts
 var NETLIFY_FUNCTIONS_DIR = ".netlify/v1/functions";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/vite-plugin-react-router",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "React Router 7+ Vite plugin for Netlify",
   "type": "commonjs",
   "main": "./dist/index.js",