Debian Codegraph @

lib/web/cookies/index.js

raw
1 'use strict'
2
3 const { parseSetCookie } = require('./parse')
4 const { stringify } = require('./util')
5 const { webidl } = require('../webidl')
6 const { Headers } = require('../fetch/headers')
7
8 const brandChecks = webidl.brandCheckMultiple([Headers, globalThis.Headers].filter(Boolean))
9
10 /**
11 * @typedef {Object} Cookie
12 * @property {string} name
13 * @property {string} value
14 * @property {Date|number} [expires]
15 * @property {number} [maxAge]
16 * @property {string} [domain]
17 * @property {string} [path]
18 * @property {boolean} [secure]
19 * @property {boolean} [httpOnly]
20 * @property {'Strict'|'Lax'|'None'} [sameSite]
21 * @property {string[]} [unparsed]
22 */
23
24 /**
25 * @param {Headers} headers
26 * @returns {Record<string, string>}
27 */
28 function getCookies (headers) {
29 webidl.argumentLengthCheck(arguments, 1, 'getCookies')
30
31 brandChecks(headers)
32
33 const cookie = headers.get('cookie')
34
35 /** @type {Record<string, string>} */
36 const out = {}
37
38 if (!cookie) {
39 return out
40 }
41
42 for (const piece of cookie.split(';')) {
43 const [name, ...value] = piece.split('=')
44
45 out[name.trim()] = value.join('=')
46 }
47
48 return out
49 }
50
51 /**
52 * @param {Headers} headers
53 * @param {string} name
54 * @param {{ path?: string, domain?: string }|undefined} attributes
55 * @returns {void}
56 */
57 function deleteCookie (headers, name, attributes) {
58 brandChecks(headers)
59
60 const prefix = 'deleteCookie'
61 webidl.argumentLengthCheck(arguments, 2, prefix)
62
63 name = webidl.converters.DOMString(name, prefix, 'name')
64 attributes = webidl.converters.DeleteCookieAttributes(attributes)
65
66 // Matches behavior of
67 // https://github.com/denoland/deno_std/blob/63827b16330b82489a04614027c33b7904e08be5/http/cookie.ts#L278
68 setCookie(headers, {
69 name,
70 value: '',
71 expires: new Date(0),
72 ...attributes
73 })
74 }
75
76 /**
77 * @param {Headers} headers
78 * @returns {Cookie[]}
79 */
80 function getSetCookies (headers) {
81 webidl.argumentLengthCheck(arguments, 1, 'getSetCookies')
82
83 brandChecks(headers)
84
85 const cookies = headers.getSetCookie()
86
87 if (!cookies) {
88 return []
89 }
90
91 return cookies.map((pair) => parseSetCookie(pair))
92 }
93
94 /**
95 * Parses a cookie string
96 * @param {string} cookie
97 */
98 function parseCookie (cookie) {
99 cookie = webidl.converters.DOMString(cookie)
100
101 return parseSetCookie(cookie)
102 }
103
104 /**
105 * @param {Headers} headers
106 * @param {Cookie} cookie
107 * @returns {void}
108 */
109 function setCookie (headers, cookie) {
110 webidl.argumentLengthCheck(arguments, 2, 'setCookie')
111
112 brandChecks(headers)
113
114 cookie = webidl.converters.Cookie(cookie)
115
116 const str = stringify(cookie)
117
118 if (str) {
119 headers.append('set-cookie', str, true)
120 }
121 }
122
123 webidl.converters.DeleteCookieAttributes = webidl.dictionaryConverter([
124 {
125 converter: webidl.nullableConverter(webidl.converters.DOMString),
126 key: 'path',
127 defaultValue: () => null
128 },
129 {
130 converter: webidl.nullableConverter(webidl.converters.DOMString),
131 key: 'domain',
132 defaultValue: () => null
133 }
134 ])
135
136 webidl.converters.Cookie = webidl.dictionaryConverter([
137 {
138 converter: webidl.converters.DOMString,
139 key: 'name'
140 },
141 {
142 converter: webidl.converters.DOMString,
143 key: 'value'
144 },
145 {
146 converter: webidl.nullableConverter((value) => {
147 if (typeof value === 'number') {
148 return webidl.converters['unsigned long long'](value)
149 }
150
151 return new Date(value)
152 }),
153 key: 'expires',
154 defaultValue: () => null
155 },
156 {
157 converter: webidl.nullableConverter(webidl.converters['long long']),
158 key: 'maxAge',
159 defaultValue: () => null
160 },
161 {
162 converter: webidl.nullableConverter(webidl.converters.DOMString),
163 key: 'domain',
164 defaultValue: () => null
165 },
166 {
167 converter: webidl.nullableConverter(webidl.converters.DOMString),
168 key: 'path',
169 defaultValue: () => null
170 },
171 {
172 converter: webidl.nullableConverter(webidl.converters.boolean),
173 key: 'secure',
174 defaultValue: () => null
175 },
176 {
177 converter: webidl.nullableConverter(webidl.converters.boolean),
178 key: 'httpOnly',
179 defaultValue: () => null
180 },
181 {
182 converter: webidl.converters.USVString,
183 key: 'sameSite',
184 allowedValues: ['Strict', 'Lax', 'None']
185 },
186 {
187 converter: webidl.sequenceConverter(webidl.converters.DOMString),
188 key: 'unparsed',
189 defaultValue: () => []
190 }
191 ])
192
193 module.exports = {
194 getCookies,
195 deleteCookie,
196 getSetCookies,
197 setCookie,
198 parseCookie
199 }