AxiosHeaders.js 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. 'use strict';
  2. import utils from '../utils.js';
  3. import parseHeaders from '../helpers/parseHeaders.js';
  4. const $internals = Symbol('internals');
  5. const isValidHeaderValue = (value) => !/[\r\n]/.test(value);
  6. function assertValidHeaderValue(value, header) {
  7. if (value === false || value == null) {
  8. return;
  9. }
  10. if (utils.isArray(value)) {
  11. value.forEach((v) => assertValidHeaderValue(v, header));
  12. return;
  13. }
  14. if (!isValidHeaderValue(String(value))) {
  15. throw new Error(`Invalid character in header content ["${header}"]`);
  16. }
  17. }
  18. function normalizeHeader(header) {
  19. return header && String(header).trim().toLowerCase();
  20. }
  21. function stripTrailingCRLF(str) {
  22. let end = str.length;
  23. while (end > 0) {
  24. const charCode = str.charCodeAt(end - 1);
  25. if (charCode !== 10 && charCode !== 13) {
  26. break;
  27. }
  28. end -= 1;
  29. }
  30. return end === str.length ? str : str.slice(0, end);
  31. }
  32. function normalizeValue(value) {
  33. if (value === false || value == null) {
  34. return value;
  35. }
  36. return utils.isArray(value) ? value.map(normalizeValue) : stripTrailingCRLF(String(value));
  37. }
  38. function parseTokens(str) {
  39. const tokens = Object.create(null);
  40. const tokensRE = /([^\s,;=]+)\s*(?:=\s*([^,;]+))?/g;
  41. let match;
  42. while ((match = tokensRE.exec(str))) {
  43. tokens[match[1]] = match[2];
  44. }
  45. return tokens;
  46. }
  47. const isValidHeaderName = (str) => /^[-_a-zA-Z0-9^`|~,!#$%&'*+.]+$/.test(str.trim());
  48. function matchHeaderValue(context, value, header, filter, isHeaderNameFilter) {
  49. if (utils.isFunction(filter)) {
  50. return filter.call(this, value, header);
  51. }
  52. if (isHeaderNameFilter) {
  53. value = header;
  54. }
  55. if (!utils.isString(value)) return;
  56. if (utils.isString(filter)) {
  57. return value.indexOf(filter) !== -1;
  58. }
  59. if (utils.isRegExp(filter)) {
  60. return filter.test(value);
  61. }
  62. }
  63. function formatHeader(header) {
  64. return header
  65. .trim()
  66. .toLowerCase()
  67. .replace(/([a-z\d])(\w*)/g, (w, char, str) => {
  68. return char.toUpperCase() + str;
  69. });
  70. }
  71. function buildAccessors(obj, header) {
  72. const accessorName = utils.toCamelCase(' ' + header);
  73. ['get', 'set', 'has'].forEach((methodName) => {
  74. Object.defineProperty(obj, methodName + accessorName, {
  75. value: function (arg1, arg2, arg3) {
  76. return this[methodName].call(this, header, arg1, arg2, arg3);
  77. },
  78. configurable: true,
  79. });
  80. });
  81. }
  82. class AxiosHeaders {
  83. constructor(headers) {
  84. headers && this.set(headers);
  85. }
  86. set(header, valueOrRewrite, rewrite) {
  87. const self = this;
  88. function setHeader(_value, _header, _rewrite) {
  89. const lHeader = normalizeHeader(_header);
  90. if (!lHeader) {
  91. throw new Error('header name must be a non-empty string');
  92. }
  93. const key = utils.findKey(self, lHeader);
  94. if (
  95. !key ||
  96. self[key] === undefined ||
  97. _rewrite === true ||
  98. (_rewrite === undefined && self[key] !== false)
  99. ) {
  100. assertValidHeaderValue(_value, _header);
  101. self[key || _header] = normalizeValue(_value);
  102. }
  103. }
  104. const setHeaders = (headers, _rewrite) =>
  105. utils.forEach(headers, (_value, _header) => setHeader(_value, _header, _rewrite));
  106. if (utils.isPlainObject(header) || header instanceof this.constructor) {
  107. setHeaders(header, valueOrRewrite);
  108. } else if (utils.isString(header) && (header = header.trim()) && !isValidHeaderName(header)) {
  109. setHeaders(parseHeaders(header), valueOrRewrite);
  110. } else if (utils.isObject(header) && utils.isIterable(header)) {
  111. let obj = {},
  112. dest,
  113. key;
  114. for (const entry of header) {
  115. if (!utils.isArray(entry)) {
  116. throw TypeError('Object iterator must return a key-value pair');
  117. }
  118. obj[(key = entry[0])] = (dest = obj[key])
  119. ? utils.isArray(dest)
  120. ? [...dest, entry[1]]
  121. : [dest, entry[1]]
  122. : entry[1];
  123. }
  124. setHeaders(obj, valueOrRewrite);
  125. } else {
  126. header != null && setHeader(valueOrRewrite, header, rewrite);
  127. }
  128. return this;
  129. }
  130. get(header, parser) {
  131. header = normalizeHeader(header);
  132. if (header) {
  133. const key = utils.findKey(this, header);
  134. if (key) {
  135. const value = this[key];
  136. if (!parser) {
  137. return value;
  138. }
  139. if (parser === true) {
  140. return parseTokens(value);
  141. }
  142. if (utils.isFunction(parser)) {
  143. return parser.call(this, value, key);
  144. }
  145. if (utils.isRegExp(parser)) {
  146. return parser.exec(value);
  147. }
  148. throw new TypeError('parser must be boolean|regexp|function');
  149. }
  150. }
  151. }
  152. has(header, matcher) {
  153. header = normalizeHeader(header);
  154. if (header) {
  155. const key = utils.findKey(this, header);
  156. return !!(
  157. key &&
  158. this[key] !== undefined &&
  159. (!matcher || matchHeaderValue(this, this[key], key, matcher))
  160. );
  161. }
  162. return false;
  163. }
  164. delete(header, matcher) {
  165. const self = this;
  166. let deleted = false;
  167. function deleteHeader(_header) {
  168. _header = normalizeHeader(_header);
  169. if (_header) {
  170. const key = utils.findKey(self, _header);
  171. if (key && (!matcher || matchHeaderValue(self, self[key], key, matcher))) {
  172. delete self[key];
  173. deleted = true;
  174. }
  175. }
  176. }
  177. if (utils.isArray(header)) {
  178. header.forEach(deleteHeader);
  179. } else {
  180. deleteHeader(header);
  181. }
  182. return deleted;
  183. }
  184. clear(matcher) {
  185. const keys = Object.keys(this);
  186. let i = keys.length;
  187. let deleted = false;
  188. while (i--) {
  189. const key = keys[i];
  190. if (!matcher || matchHeaderValue(this, this[key], key, matcher, true)) {
  191. delete this[key];
  192. deleted = true;
  193. }
  194. }
  195. return deleted;
  196. }
  197. normalize(format) {
  198. const self = this;
  199. const headers = {};
  200. utils.forEach(this, (value, header) => {
  201. const key = utils.findKey(headers, header);
  202. if (key) {
  203. self[key] = normalizeValue(value);
  204. delete self[header];
  205. return;
  206. }
  207. const normalized = format ? formatHeader(header) : String(header).trim();
  208. if (normalized !== header) {
  209. delete self[header];
  210. }
  211. self[normalized] = normalizeValue(value);
  212. headers[normalized] = true;
  213. });
  214. return this;
  215. }
  216. concat(...targets) {
  217. return this.constructor.concat(this, ...targets);
  218. }
  219. toJSON(asStrings) {
  220. const obj = Object.create(null);
  221. utils.forEach(this, (value, header) => {
  222. value != null &&
  223. value !== false &&
  224. (obj[header] = asStrings && utils.isArray(value) ? value.join(', ') : value);
  225. });
  226. return obj;
  227. }
  228. [Symbol.iterator]() {
  229. return Object.entries(this.toJSON())[Symbol.iterator]();
  230. }
  231. toString() {
  232. return Object.entries(this.toJSON())
  233. .map(([header, value]) => header + ': ' + value)
  234. .join('\n');
  235. }
  236. getSetCookie() {
  237. return this.get('set-cookie') || [];
  238. }
  239. get [Symbol.toStringTag]() {
  240. return 'AxiosHeaders';
  241. }
  242. static from(thing) {
  243. return thing instanceof this ? thing : new this(thing);
  244. }
  245. static concat(first, ...targets) {
  246. const computed = new this(first);
  247. targets.forEach((target) => computed.set(target));
  248. return computed;
  249. }
  250. static accessor(header) {
  251. const internals =
  252. (this[$internals] =
  253. this[$internals] =
  254. {
  255. accessors: {},
  256. });
  257. const accessors = internals.accessors;
  258. const prototype = this.prototype;
  259. function defineAccessor(_header) {
  260. const lHeader = normalizeHeader(_header);
  261. if (!accessors[lHeader]) {
  262. buildAccessors(prototype, _header);
  263. accessors[lHeader] = true;
  264. }
  265. }
  266. utils.isArray(header) ? header.forEach(defineAccessor) : defineAccessor(header);
  267. return this;
  268. }
  269. }
  270. AxiosHeaders.accessor([
  271. 'Content-Type',
  272. 'Content-Length',
  273. 'Accept',
  274. 'Accept-Encoding',
  275. 'User-Agent',
  276. 'Authorization',
  277. ]);
  278. // reserved names hotfix
  279. utils.reduceDescriptors(AxiosHeaders.prototype, ({ value }, key) => {
  280. let mapped = key[0].toUpperCase() + key.slice(1); // map `set` => `Set`
  281. return {
  282. get: () => value,
  283. set(headerValue) {
  284. this[mapped] = headerValue;
  285. },
  286. };
  287. });
  288. utils.freezeMethods(AxiosHeaders);
  289. export default AxiosHeaders;