Merge branch 'add-route-events-types' of https://github.com/LauraBeatris/next.js into add-route-events-types

Author: LauraBeatris

docs/api-reference/next.config.js/basepath.md

@@ -4,6 +4,8 @@ description: Learn more about setting a base path in Next.js
 
 # Base Path
 
+> This feature was introduced in [Next.js 9.5](https://nextjs.org/blog/next-9-5) and up. If you’re using older versions of Next.js, please upgrade before trying it out.
+
 To deploy a Next.js application under a sub-path of a domain you can use the `basePath` option.
 
 `basePath` allows you to set a path prefix for the application. For example `/docs` instead of `/` (the default).

docs/api-reference/next.config.js/headers.md

@@ -4,6 +4,8 @@ description: Add custom HTTP headers to your Next.js app.
 
 # Headers
 
+> This feature was introduced in [Next.js 9.5](https://nextjs.org/blog/next-9-5) and up. If you’re using older versions of Next.js, please upgrade before trying it out.
+
 Headers allow you to set custom HTTP headers for an incoming request path.
 
 To set custom HTTP headers you can use the `headers` key in `next.config.js`:
@@ -90,6 +92,28 @@ module.exports = {
 }
 ```
 
+### Regex Path Matching
+
+To match a regex path you can wrap the regex in parenthesis after a parameter, for example `/blog/:slug(\\d{1,})` will match `/blog/123` but not `/blog/abc`:
+
+```js
+module.exports = {
+  async rewrites() {
+    return [
+      {
+        source: '/blog/:post(\\d{1,})',
+        headers: [
+          {
+            key: 'x-post',
+            value: ':post',
+          },
+        ],
+      },
+    ]
+  },
+}
+```
+
 ### Headers with basePath support
 
 When leveraging [`basePath` support](/docs/api-reference/next.config.js/basepath.md) with headers each `source` is automatically prefixed with the `basePath` unless you add `basePath: false` to the header:

docs/api-reference/next.config.js/redirects.md

@@ -4,6 +4,8 @@ description: Add redirects to your Next.js app.
 
 # Redirects
 
+> This feature was introduced in [Next.js 9.5](https://nextjs.org/blog/next-9-5) and up. If you’re using older versions of Next.js, please upgrade before trying it out.
+
 Redirects allow you to redirect an incoming request path to a different destination path.
 
 Redirects are only available on the Node.js environment and do not affect client-side routing.
@@ -66,6 +68,24 @@ module.exports = {
 }
 ```
 
+### Regex Path Matching
+
+To match a regex path you can wrap the regex in parenthesis after a parameter, for example `/blog/:slug(\\d{1,})` will match `/blog/123` but not `/blog/abc`:
+
+```js
+module.exports = {
+  async redirects() {
+    return [
+      {
+        source: '/old-blog/:post(\\d{1,})',
+        destination: '/blog/:post', // Matched parameters can be used in the destination
+        permanent: false,
+      },
+    ]
+  },
+}
+```
+
 ### Redirects with basePath support
 
 When leveraging [`basePath` support](/docs/api-reference/next.config.js/basepath.md) with redirects each `source` and `destination` is automatically prefixed with the `basePath` unless you add `basePath: false` to the redirect:

docs/api-reference/next.config.js/rewrites.md

@@ -4,6 +4,8 @@ description: Add rewrites to your Next.js app.
 
 # Rewrites
 
+> This feature was introduced in [Next.js 9.5](https://nextjs.org/blog/next-9-5) and up. If you’re using older versions of Next.js, please upgrade before trying it out.
+
 <details open>
   <summary><b>Examples</b></summary>
   <ul>
@@ -69,6 +71,23 @@ module.exports = {
 }
 ```
 
+### Regex Path Matching
+
+To match a regex path you can wrap the regex in parenthesis after a parameter, for example `/blog/:slug(\\d{1,})` will match `/blog/123` but not `/blog/abc`:
+
+```js
+module.exports = {
+  async rewrites() {
+    return [
+      {
+        source: '/old-blog/:post(\\d{1,})',
+        destination: '/blog/:post', // Matched parameters can be used in the destination
+      },
+    ]
+  },
+}
+```
+
 ## Rewriting to an external URL
 
 <details>

docs/api-reference/next.config.js/trailing-slash.md

@@ -4,6 +4,8 @@ description: Configure Next.js pages to resolve with or without a trailing slash
 
 # Trailing Slash
 
+> This feature was introduced in [Next.js 9.5](https://nextjs.org/blog/next-9-5) and up. If you’re using older versions of Next.js, please upgrade before trying it out.
+
 By default Next.js will redirect urls with trailing slashes to their counterpart without a trailing slash. For example `/about/` will redirect to `/about`. You can configure this behavior to act the opposite way, where urls without trailing slashes are redirected to their counterparts with trailing slashes.
 
 Open `next.config.js` and add the `trailingSlash` config:

docs/deployment.md

@@ -40,7 +40,7 @@ By using the DPS workflow, in addition to doing _code reviews_, you can do _depl
 For example, the [hybrid pages](/docs/basic-features/pages.md) approach is fully supported out of the box.
 
 - Every page can either use [Static Generation](/docs/basic-features/pages.md#static-generation) or [Server-Side Rendering](/docs/basic-features/pages.md#server-side-rendering).
-- Pages that use [Static Generation](/docs/basic-features/pages.md#static-generation) and assets (JS, CSS, images, fonts, etc) will automatically be served from the [Vercel Smart CDN](https://vercel.com/smart-cdn), which is blazingly fast.
+- Pages that use [Static Generation](/docs/basic-features/pages.md#static-generation) and assets (JS, CSS, images, fonts, etc) will automatically be served from the [Vercel's Edge Network](https://vercel.com/docs/v2/edge-network/overview), which is blazingly fast.
 - Pages that use [Server-Side Rendering](/docs/basic-features/pages.md#server-side-rendering) and [API routes](/docs/api-routes/introduction.md) will automatically become isolated Serverless Functions. This allows page rendering and API requests to scale infinitely.
 
 ### Custom Domains, Environment Variables, Automatic HTTPS, and more

docs/getting-started.md

@@ -41,19 +41,19 @@ Open `package.json` and add the following `scripts`:
 
 ```json
 "scripts": {
-  "dev": "next",
+  "dev": "next dev",
   "build": "next build",
   "start": "next start"
 }
 ```
 
 These scripts refer to the different stages of developing an application:
 
-- `dev` - Runs `next` which starts Next.js in development mode
-- `build` - Runs `next build` which builds the application for production usage
-- `start` - Runs `next start` which starts a Next.js production server
+- `dev` - Runs [`next dev`](/docs/api-reference/cli#development) which starts Next.js in development mode
+- `build` - Runs [`next build`](/docs/api-reference/cli#build) which builds the application for production usage
+- `start` - Runs [`next start`](/docs/api-reference/cli#production) which starts a Next.js production server
 
-Next.js is built around the concept of pages. A page is a [React Component](https://reactjs.org/docs/components-and-props.html) exported from a `.js`, `.jsx`, `.ts`, or `.tsx` file in the `pages` directory.
+Next.js is built around the concept of [pages](/docs/basic-features/pages.md). A page is a [React Component](https://reactjs.org/docs/components-and-props.html) exported from a `.js`, `.jsx`, `.ts`, or `.tsx` file in the `pages` directory.
 
 Pages are associated with a route based on their file name. For example `pages/about.js` is mapped to `/about`. You can even add dynamic route parameters with the filename.
 

docs/routing/dynamic-routes.md

@@ -108,5 +108,6 @@ The `query` objects are as follows:
   - `pages/post/[pid].js` - Will match `/post/1`, `/post/abc`, etc. But not `/post/create`
   - `pages/post/[...slug].js` - Will match `/post/1/2`, `/post/a/b/c`, etc. But not `/post/create`, `/post/abc`
 - Pages that are statically optimized by [Automatic Static Optimization](/docs/advanced-features/automatic-static-optimization.md) will be hydrated without their route parameters provided, i.e `query` will be an empty object (`{}`).
+- When routing to a dynamic route using `Link` or `router`, you will need to specify the `href` as the dynamic route, for example `/post/[pid]` and `as` as the decorator for the URL, for example `/post/abc`.
 
   After hydration, Next.js will trigger an update to your application to provide the route parameters in the `query` object.

errors/popstate-state-empty.md

@@ -2,12 +2,12 @@
 
 #### Why This Error Occurred
 
-When using the browser back button the popstate event is triggered. Next.js sets
-`popstate` event triggered but `event.state` did not have `url` or `as`, causing a route change failure
+When using the browser back button the popstate event is triggered. Next.js sees a
+`popstate` event being triggered but `event.state` did not have `url` or `as`, causing a route change failure.
 
 #### Possible Ways to Fix It
 
-The only known cause of this issue is manually manipulating `window.history` instead of using `next/router`
+The only known cause of this issue is manually manipulating `window.history` instead of using `next/router`. Starting from version 9.5, Next.js will ignore `popstate` events that contain `event.state` not created by its own router.
 
 ### Useful Links
 

examples/auth0/.env.local.example

@@ -0,0 +1,11 @@
+# Public Environment variables that can be used in the browser.
+NEXT_PUBLIC_AUTH0_CLIENT_ID=
+NEXT_PUBLIC_AUTH0_SCOPE="openid profile"
+NEXT_PUBLIC_AUTH0_DOMAIN=
+NEXT_PUBLIC_REDIRECT_URI="http://localhost:3000/api/callback"
+NEXT_PUBLIC_POST_LOGOUT_REDIRECT_URI="http://localhost:3000"
+
+# Secret environment variables only available to Node.js
+AUTH0_CLIENT_SECRET=
+SESSION_COOKIE_SECRET=
+SESSION_COOKIE_LIFETIME=7200