2021-10-20 19:52:11 +02:00
|
|
|
import type { I18NConfig } from '../../config-shared'
|
2021-11-19 18:09:52 +01:00
|
|
|
import type { RequestData } from '../types'
|
2021-10-20 19:52:11 +02:00
|
|
|
import { NextURL } from '../next-url'
|
2022-05-30 14:01:36 +02:00
|
|
|
import { toNodeHeaders, validateURL } from '../utils'
|
2022-06-09 13:10:21 +02:00
|
|
|
import { RemovedUAError, RemovedPageError } from '../error'
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
import { NextCookies } from './cookies'
|
|
|
|
|
2021-10-20 19:52:11 +02:00
|
|
|
export const INTERNALS = Symbol('internal request')
|
|
|
|
|
|
|
|
export class NextRequest extends Request {
|
|
|
|
[INTERNALS]: {
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
cookies: NextCookies
|
2021-11-19 18:09:52 +01:00
|
|
|
geo: RequestData['geo']
|
2021-10-20 19:52:11 +02:00
|
|
|
ip?: string
|
|
|
|
url: NextURL
|
|
|
|
}
|
|
|
|
|
2022-07-21 20:29:19 +02:00
|
|
|
constructor(input: URL | RequestInfo, init: RequestInit = {}) {
|
|
|
|
const url =
|
|
|
|
typeof input !== 'string' && 'url' in input ? input.url : String(input)
|
2022-05-30 14:01:36 +02:00
|
|
|
validateURL(url)
|
2022-07-21 20:29:19 +02:00
|
|
|
super(url, init)
|
2021-10-20 19:52:11 +02:00
|
|
|
this[INTERNALS] = {
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
cookies: new NextCookies(this),
|
2021-10-20 19:52:11 +02:00
|
|
|
geo: init.geo || {},
|
|
|
|
ip: init.ip,
|
2022-05-30 14:01:36 +02:00
|
|
|
url: new NextURL(url, {
|
2021-10-20 19:52:11 +02:00
|
|
|
headers: toNodeHeaders(this.headers),
|
2022-05-27 20:29:04 +02:00
|
|
|
nextConfig: init.nextConfig,
|
2021-10-20 19:52:11 +02:00
|
|
|
}),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-07-27 16:16:16 +02:00
|
|
|
[Symbol.for('edge-runtime.inspect.custom')]() {
|
|
|
|
return {
|
|
|
|
cookies: this.cookies,
|
|
|
|
geo: this.geo,
|
|
|
|
ip: this.ip,
|
|
|
|
nextUrl: this.nextUrl,
|
|
|
|
url: this.url,
|
|
|
|
// rest of props come from Request
|
|
|
|
bodyUsed: this.bodyUsed,
|
|
|
|
cache: this.cache,
|
|
|
|
credentials: this.credentials,
|
|
|
|
destination: this.destination,
|
|
|
|
headers: Object.fromEntries(this.headers),
|
|
|
|
integrity: this.integrity,
|
|
|
|
keepalive: this.keepalive,
|
|
|
|
method: this.method,
|
|
|
|
mode: this.mode,
|
|
|
|
redirect: this.redirect,
|
|
|
|
referrer: this.referrer,
|
|
|
|
referrerPolicy: this.referrerPolicy,
|
|
|
|
signal: this.signal,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-10-20 19:52:11 +02:00
|
|
|
public get cookies() {
|
feat: better cookies API for Edge Functions (#36478)
This PR introduces a more predictable API to manipulate cookies in an Edge Function context.
```js
const response = new NextResponse()
// set a cookie
response.cookies.set('foo, 'bar') // => set-cookie: 'foo=bar; Path=/'`
// set another cookie
response.cookies.set('fooz, 'barz') // => set-cookie: 'foo=bar; Path=/, fooz=barz; Path=/'`
// delete a cookie means mark it as expired
response.cookies.delete('foo') // => set-cookie: 'foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, fooz=barz; Path=/'`
// clear all cookies means mark all of them as expired
response.cookies.clear() // => set-cookie: 'fooz=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT, foo=; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT'`
```
This new cookies API uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) interface, and it's available for `NextRequest` and `NextResponse`.
Additionally, you can pass a specific cookies option as a third argument in `set` method:
```js
response.cookies.set('foo', 'bar', {
path: '/',
maxAge: 60 * 60 * 24 * 7,
httpOnly: true,
sameSite: 'strict',
domain: 'example.com'
}
```
**Note**: `maxAge` it's in seconds rather than milliseconds.
Any cookie manipulation will be reflected over the `set-cookie` header, transparently.
closes #31719
2022-05-09 11:50:32 +02:00
|
|
|
return this[INTERNALS].cookies
|
2021-10-20 19:52:11 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
public get geo() {
|
|
|
|
return this[INTERNALS].geo
|
|
|
|
}
|
|
|
|
|
|
|
|
public get ip() {
|
|
|
|
return this[INTERNALS].ip
|
|
|
|
}
|
|
|
|
|
|
|
|
public get nextUrl() {
|
|
|
|
return this[INTERNALS].url
|
|
|
|
}
|
|
|
|
|
2022-08-08 16:40:44 +02:00
|
|
|
/**
|
|
|
|
* @deprecated
|
|
|
|
* `page` has been deprecated in favour of `URLPattern`.
|
|
|
|
* Read more: https://nextjs.org/docs/messages/middleware-request-page
|
|
|
|
*/
|
2021-10-20 19:52:11 +02:00
|
|
|
public get page() {
|
2022-06-09 13:10:21 +02:00
|
|
|
throw new RemovedPageError()
|
2021-10-20 19:52:11 +02:00
|
|
|
}
|
|
|
|
|
2022-08-08 16:40:44 +02:00
|
|
|
/**
|
|
|
|
* @deprecated
|
|
|
|
* `ua` has been removed in favour of \`userAgent\` function.
|
|
|
|
* Read more: https://nextjs.org/docs/messages/middleware-parse-user-agent
|
|
|
|
*/
|
2021-10-20 19:52:11 +02:00
|
|
|
public get ua() {
|
2022-06-09 13:10:21 +02:00
|
|
|
throw new RemovedUAError()
|
2021-10-20 19:52:11 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
public get url() {
|
|
|
|
return this[INTERNALS].url.toString()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-10-26 00:59:41 +02:00
|
|
|
export interface RequestInit extends globalThis.RequestInit {
|
2021-10-20 19:52:11 +02:00
|
|
|
geo?: {
|
|
|
|
city?: string
|
|
|
|
country?: string
|
|
|
|
region?: string
|
|
|
|
}
|
|
|
|
ip?: string
|
|
|
|
nextConfig?: {
|
|
|
|
basePath?: string
|
|
|
|
i18n?: I18NConfig | null
|
|
|
|
trailingSlash?: boolean
|
|
|
|
}
|
|
|
|
}
|