index.js 4.3 KB

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