b78c28f7a0
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
131 lines
2.6 KiB
TypeScript
131 lines
2.6 KiB
TypeScript
import type { I18NConfig } from '../../config-shared'
|
|
import type { RequestData } from '../types'
|
|
import { NextURL } from '../next-url'
|
|
import { isBot } from '../../utils'
|
|
import { toNodeHeaders } from '../utils'
|
|
import parseua from 'next/dist/compiled/ua-parser-js'
|
|
|
|
import { NextCookies } from './cookies'
|
|
|
|
export const INTERNALS = Symbol('internal request')
|
|
|
|
export class NextRequest extends Request {
|
|
[INTERNALS]: {
|
|
cookies: NextCookies
|
|
geo: RequestData['geo']
|
|
ip?: string
|
|
page?: { name?: string; params?: { [key: string]: string | string[] } }
|
|
ua?: UserAgent | null
|
|
url: NextURL
|
|
}
|
|
|
|
constructor(input: Request | string, init: RequestInit = {}) {
|
|
super(input, init)
|
|
|
|
this[INTERNALS] = {
|
|
cookies: new NextCookies(this),
|
|
geo: init.geo || {},
|
|
ip: init.ip,
|
|
page: init.page,
|
|
url: new NextURL(typeof input === 'string' ? input : input.url, {
|
|
basePath: init.nextConfig?.basePath,
|
|
headers: toNodeHeaders(this.headers),
|
|
i18n: init.nextConfig?.i18n,
|
|
trailingSlash: init.nextConfig?.trailingSlash,
|
|
}),
|
|
}
|
|
}
|
|
|
|
public get cookies() {
|
|
return this[INTERNALS].cookies
|
|
}
|
|
|
|
public get geo() {
|
|
return this[INTERNALS].geo
|
|
}
|
|
|
|
public get ip() {
|
|
return this[INTERNALS].ip
|
|
}
|
|
|
|
public get preflight() {
|
|
return this.headers.get('x-middleware-preflight')
|
|
}
|
|
|
|
public get nextUrl() {
|
|
return this[INTERNALS].url
|
|
}
|
|
|
|
public get page() {
|
|
return {
|
|
name: this[INTERNALS].page?.name,
|
|
params: this[INTERNALS].page?.params,
|
|
}
|
|
}
|
|
|
|
public get ua() {
|
|
if (typeof this[INTERNALS].ua !== 'undefined') {
|
|
return this[INTERNALS].ua || undefined
|
|
}
|
|
|
|
const uaString = this.headers.get('user-agent')
|
|
if (!uaString) {
|
|
this[INTERNALS].ua = null
|
|
return this[INTERNALS].ua || undefined
|
|
}
|
|
|
|
this[INTERNALS].ua = {
|
|
...parseua(uaString),
|
|
isBot: isBot(uaString),
|
|
}
|
|
|
|
return this[INTERNALS].ua
|
|
}
|
|
|
|
public get url() {
|
|
return this[INTERNALS].url.toString()
|
|
}
|
|
}
|
|
|
|
export interface RequestInit extends globalThis.RequestInit {
|
|
geo?: {
|
|
city?: string
|
|
country?: string
|
|
region?: string
|
|
}
|
|
ip?: string
|
|
nextConfig?: {
|
|
basePath?: string
|
|
i18n?: I18NConfig | null
|
|
trailingSlash?: boolean
|
|
}
|
|
page?: {
|
|
name?: string
|
|
params?: { [key: string]: string | string[] }
|
|
}
|
|
}
|
|
|
|
interface UserAgent {
|
|
isBot: boolean
|
|
ua: string
|
|
browser: {
|
|
name?: string
|
|
version?: string
|
|
}
|
|
device: {
|
|
model?: string
|
|
type?: string
|
|
vendor?: string
|
|
}
|
|
engine: {
|
|
name?: string
|
|
version?: string
|
|
}
|
|
os: {
|
|
name?: string
|
|
version?: string
|
|
}
|
|
cpu: {
|
|
architecture?: string
|
|
}
|
|
}
|