content-type 1.0.4 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,78 +1,55 @@
1
1
  # content-type
2
2
 
3
- [![NPM Version][npm-image]][npm-url]
4
- [![NPM Downloads][downloads-image]][downloads-url]
5
- [![Node.js Version][node-version-image]][node-version-url]
6
- [![Build Status][travis-image]][travis-url]
7
- [![Test Coverage][coveralls-image]][coveralls-url]
3
+ [![NPM version][npm-image]][npm-url]
4
+ [![NPM downloads][downloads-image]][downloads-url]
5
+ [![Build status][build-image]][build-url]
6
+ [![Build coverage][coverage-image]][coverage-url]
7
+ [![License][license-image]][license-url]
8
8
 
9
- Create and parse HTTP Content-Type header according to RFC 7231
9
+ Create and parse HTTP `Content-Type` header.
10
10
 
11
11
  ## Installation
12
12
 
13
13
  ```sh
14
- $ npm install content-type
14
+ npm install content-type
15
15
  ```
16
16
 
17
17
  ## API
18
18
 
19
19
  ```js
20
- var contentType = require('content-type')
20
+ const contentType = require("content-type");
21
21
  ```
22
22
 
23
- ### contentType.parse(string)
23
+ ### contentType.parse(string, options?)
24
24
 
25
25
  ```js
26
- var obj = contentType.parse('image/svg+xml; charset=utf-8')
26
+ const obj = contentType.parse("image/svg+xml; charset=utf-8");
27
27
  ```
28
28
 
29
- Parse a content type string. This will return an object with the following
30
- properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
29
+ Parse a `Content-Type` header. This will return an object with the following properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
31
30
 
32
- - `type`: The media type (the type and subtype, always lower case).
33
- Example: `'image/svg+xml'`
31
+ - `type`: The media type. Example: `'image/svg+xml'`.
32
+ - `parameters`: An object of the parameters in the media type (parameter name is always lower case). Example: `{charset: 'utf-8'}`.
34
33
 
35
- - `parameters`: An object of the parameters in the media type (name of parameter
36
- always lower case). Example: `{charset: 'utf-8'}`
34
+ The parser is lenient and does not error. You should validate `type` and `parameters` before trusting them.
37
35
 
38
- Throws a `TypeError` if the string is missing or invalid.
36
+ #### Options
39
37
 
40
- ### contentType.parse(req)
41
-
42
- ```js
43
- var obj = contentType.parse(req)
44
- ```
45
-
46
- Parse the `content-type` header from the given `req`. Short-cut for
47
- `contentType.parse(req.headers['content-type'])`.
48
-
49
- Throws a `TypeError` if the `Content-Type` header is missing or invalid.
50
-
51
- ### contentType.parse(res)
52
-
53
- ```js
54
- var obj = contentType.parse(res)
55
- ```
56
-
57
- Parse the `content-type` header set on the given `res`. Short-cut for
58
- `contentType.parse(res.getHeader('content-type'))`.
59
-
60
- Throws a `TypeError` if the `Content-Type` header is missing or invalid.
38
+ - `parameters` (default: `true`): Set to `false` to skip parameters.
61
39
 
62
40
  ### contentType.format(obj)
63
41
 
64
42
  ```js
65
- var str = contentType.format({type: 'image/svg+xml'})
43
+ const str = contentType.format({
44
+ type: "image/svg+xml",
45
+ parameters: { charset: "utf-8" },
46
+ });
66
47
  ```
67
48
 
68
- Format an object into a content type string. This will return a string of the
69
- content type for the given object with the following properties (examples are
70
- shown that produce the string `'image/svg+xml; charset=utf-8'`):
71
-
72
- - `type`: The media type (will be lower-cased). Example: `'image/svg+xml'`
49
+ Format an object into a `Content-Type` header. This will return a string of the content type for the given object with the following properties (examples are shown that produce the string `'image/svg+xml; charset=utf-8'`):
73
50
 
74
- - `parameters`: An object of the parameters in the media type (name of the
75
- parameter will be lower-cased). Example: `{charset: 'utf-8'}`
51
+ - `type`: The media type. Example: `'image/svg+xml'`.
52
+ - `parameters`: An optional object of the parameters in the media type. Example: `{charset: 'utf-8'}`.
76
53
 
77
54
  Throws a `TypeError` if the object contains an invalid type or parameter names.
78
55
 
@@ -80,13 +57,13 @@ Throws a `TypeError` if the object contains an invalid type or parameter names.
80
57
 
81
58
  [MIT](LICENSE)
82
59
 
83
- [npm-image]: https://img.shields.io/npm/v/content-type.svg
60
+ [npm-image]: https://img.shields.io/npm/v/content-type
84
61
  [npm-url]: https://npmjs.org/package/content-type
85
- [node-version-image]: https://img.shields.io/node/v/content-type.svg
86
- [node-version-url]: http://nodejs.org/download/
87
- [travis-image]: https://img.shields.io/travis/jshttp/content-type/master.svg
88
- [travis-url]: https://travis-ci.org/jshttp/content-type
89
- [coveralls-image]: https://img.shields.io/coveralls/jshttp/content-type/master.svg
90
- [coveralls-url]: https://coveralls.io/r/jshttp/content-type
91
- [downloads-image]: https://img.shields.io/npm/dm/content-type.svg
62
+ [downloads-image]: https://img.shields.io/npm/dm/content-type
92
63
  [downloads-url]: https://npmjs.org/package/content-type
64
+ [build-image]: https://img.shields.io/github/actions/workflow/status/jshttp/content-type/ci.yml?branch=master
65
+ [build-url]: https://github.com/jshttp/content-type/actions/workflows/ci.yml?query=branch%3Amaster
66
+ [coverage-image]: https://img.shields.io/codecov/c/gh/jshttp/content-type
67
+ [coverage-url]: https://codecov.io/gh/jshttp/content-type
68
+ [license-image]: http://img.shields.io/npm/l/content-type.svg?style=flat
69
+ [license-url]: LICENSE
@@ -0,0 +1,26 @@
1
+ /*!
2
+ * content-type
3
+ * Copyright(c) 2015 Douglas Christopher Wilson
4
+ * MIT Licensed
5
+ */
6
+ /**
7
+ * The content type object contains a type string and optional parameters.
8
+ */
9
+ export interface ContentType {
10
+ type: string;
11
+ parameters: Record<string, string>;
12
+ }
13
+ /**
14
+ * Format an object into a `Content-Type` header.
15
+ */
16
+ export declare function format(obj: Partial<ContentType>): string;
17
+ /**
18
+ * Options for parsing a `Content-Type` header.
19
+ */
20
+ export interface ParseOptions {
21
+ parameters?: boolean;
22
+ }
23
+ /**
24
+ * Parse a `Content-Type` header.
25
+ */
26
+ export declare function parse(header: string, options?: ParseOptions): ContentType;
package/dist/index.js ADDED
@@ -0,0 +1,170 @@
1
+ "use strict";
2
+ /*!
3
+ * content-type
4
+ * Copyright(c) 2015 Douglas Christopher Wilson
5
+ * MIT Licensed
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.format = format;
9
+ exports.parse = parse;
10
+ const TEXT_REGEXP = /^[\u0009\u0020-\u007e\u0080-\u00ff]*$/;
11
+ const TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;
12
+ /**
13
+ * RegExp to match chars that must be quoted-pair in RFC 9110 sec 5.6.4
14
+ */
15
+ const QUOTE_REGEXP = /[\\"]/g;
16
+ /**
17
+ * RegExp to match type in RFC 9110 sec 8.3.1
18
+ *
19
+ * media-type = type "/" subtype
20
+ * type = token
21
+ * subtype = token
22
+ */
23
+ const TYPE_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;
24
+ /**
25
+ * Null object perf optimization. Faster than `Object.create(null)` and `{ __proto__: null }`.
26
+ */
27
+ const NullObject = /* @__PURE__ */ (() => {
28
+ const C = function () { };
29
+ C.prototype = Object.create(null);
30
+ return C;
31
+ })();
32
+ /**
33
+ * Format an object into a `Content-Type` header.
34
+ */
35
+ function format(obj) {
36
+ const { type, parameters } = obj;
37
+ if (!type || !TYPE_REGEXP.test(type)) {
38
+ throw new TypeError(`Invalid type: ${type}`);
39
+ }
40
+ let result = type;
41
+ if (parameters) {
42
+ for (const param of Object.keys(parameters)) {
43
+ if (!TOKEN_REGEXP.test(param)) {
44
+ throw new TypeError(`Invalid parameter name: ${param}`);
45
+ }
46
+ result += `; ${param}=${qstring(parameters[param])}`;
47
+ }
48
+ }
49
+ return result;
50
+ }
51
+ /**
52
+ * Parse a `Content-Type` header.
53
+ */
54
+ function parse(header, options) {
55
+ const len = header.length;
56
+ let index = skipOWS(header, 0, len);
57
+ const valueStart = index;
58
+ index = skipValue(header, index, len);
59
+ const valueEnd = trailingOWS(header, valueStart, index);
60
+ const type = header.slice(valueStart, valueEnd).toLowerCase();
61
+ const parameters = options?.parameters === false
62
+ ? new NullObject()
63
+ : parseParameters(header, index, len);
64
+ return { type, parameters };
65
+ }
66
+ const SP = 32; // " "
67
+ const HTAB = 9; // "\t"
68
+ const SEMI = 59; // ";"
69
+ const EQ = 61; // "="
70
+ const DQUOTE = 34; // '"'
71
+ const BSLASH = 92; // "\\"
72
+ /**
73
+ * Parses the parameters of a `Content-Type` header starting at the given index.
74
+ */
75
+ function parseParameters(header, index, len) {
76
+ const parameters = new NullObject();
77
+ parameter: while (index < len) {
78
+ index = skipOWS(header, index + 1 /* Skip over ; */, len);
79
+ const keyStart = index;
80
+ while (index < len) {
81
+ const code = header.charCodeAt(index);
82
+ if (code === SEMI)
83
+ continue parameter;
84
+ if (code === EQ) {
85
+ const keyEnd = trailingOWS(header, keyStart, index);
86
+ const key = header.slice(keyStart, keyEnd).toLowerCase();
87
+ index = skipOWS(header, index + 1, len);
88
+ if (index < len && header.charCodeAt(index) === DQUOTE) {
89
+ index++;
90
+ let value = "";
91
+ while (index < len) {
92
+ const code = header.charCodeAt(index++);
93
+ if (code === DQUOTE) {
94
+ index = skipValue(header, index, len);
95
+ if (parameters[key] === undefined)
96
+ parameters[key] = value;
97
+ break;
98
+ }
99
+ if (code === BSLASH && index < len) {
100
+ value += header[index++];
101
+ continue;
102
+ }
103
+ value += String.fromCharCode(code);
104
+ }
105
+ continue parameter;
106
+ }
107
+ const valueStart = index;
108
+ index = skipValue(header, index, len);
109
+ if (parameters[key] === undefined) {
110
+ const valueEnd = trailingOWS(header, valueStart, index);
111
+ parameters[key] = header.slice(valueStart, valueEnd);
112
+ }
113
+ continue parameter;
114
+ }
115
+ index++;
116
+ }
117
+ }
118
+ return parameters;
119
+ }
120
+ /**
121
+ * Skip over characters until a semicolon.
122
+ */
123
+ function skipValue(str, index, len) {
124
+ while (index < len) {
125
+ const char = str.charCodeAt(index);
126
+ if (char === SEMI)
127
+ break;
128
+ index++;
129
+ }
130
+ return index;
131
+ }
132
+ /**
133
+ * Skip optional whitespace (OWS) in an HTTP header value.
134
+ *
135
+ * OWS is defined in RFC 9110 sec 5.6.3 as SP (" ") or HTAB ("\t").
136
+ */
137
+ function skipOWS(header, index, len) {
138
+ while (index < len) {
139
+ const char = header.charCodeAt(index);
140
+ if (char !== SP && char !== HTAB)
141
+ break;
142
+ index++;
143
+ }
144
+ return index;
145
+ }
146
+ /**
147
+ * Trim optional whitespace (OWS) from the end of a substring.
148
+ *
149
+ * OWS is defined in RFC 9110 sec 5.6.3 as SP (" ") or HTAB ("\t").
150
+ */
151
+ function trailingOWS(header, start, end) {
152
+ while (end > start) {
153
+ const char = header.charCodeAt(end - 1);
154
+ if (char !== SP && char !== HTAB)
155
+ break;
156
+ end--;
157
+ }
158
+ return end;
159
+ }
160
+ /**
161
+ * Serialize a parameter value.
162
+ */
163
+ function qstring(str) {
164
+ if (TOKEN_REGEXP.test(str))
165
+ return str;
166
+ if (TEXT_REGEXP.test(str))
167
+ return `"${str.replace(QUOTE_REGEXP, "\\$&")}"`;
168
+ throw new TypeError(`Invalid parameter value: ${str}`);
169
+ }
170
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAwCH,wBAoBC;AAYD,sBAcC;AApFD,MAAM,WAAW,GAAG,uCAAuC,CAAC;AAC5D,MAAM,YAAY,GAAG,+BAA+B,CAAC;AAErD;;GAEG;AACH,MAAM,YAAY,GAAG,QAAQ,CAAC;AAE9B;;;;;;GAMG;AACH,MAAM,WAAW,GACf,4DAA4D,CAAC;AAE/D;;GAEG;AACH,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvC,MAAM,CAAC,GAAG,cAAa,CAAC,CAAC;IACzB,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO,CAAC,CAAC;AACX,CAAC,CAAC,EAAgC,CAAC;AAUnC;;GAEG;AACH,SAAgB,MAAM,CAAC,GAAyB;IAC9C,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAEjC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,SAAS,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,IAAI,UAAU,EAAE,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,SAAS,CAAC,2BAA2B,KAAK,EAAE,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,IAAI,KAAK,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACvD,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AASD;;GAEG;AACH,SAAgB,KAAK,CAAC,MAAc,EAAE,OAAsB;IAC1D,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1B,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;IAEpC,MAAM,UAAU,GAAG,KAAK,CAAC;IACzB,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9D,MAAM,UAAU,GACd,OAAO,EAAE,UAAU,KAAK,KAAK;QAC3B,CAAC,CAAC,IAAI,UAAU,EAAE;QAClB,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAE1C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM;AACrB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO;AACvB,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,MAAM;AACvB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM;AACrB,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,MAAM;AACzB,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,OAAO;AAE1B;;GAEG;AACH,SAAS,eAAe,CACtB,MAAc,EACd,KAAa,EACb,GAAW;IAEX,MAAM,UAAU,GAA2B,IAAI,UAAU,EAAE,CAAC;IAE5D,SAAS,EAAE,OAAO,KAAK,GAAG,GAAG,EAAE,CAAC;QAC9B,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;QAE1D,MAAM,QAAQ,GAAG,KAAK,CAAC;QAEvB,OAAO,KAAK,GAAG,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,IAAI,KAAK,IAAI;gBAAE,SAAS,SAAS,CAAC;YAEtC,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gBAChB,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACpD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;gBAEzD,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;gBAExC,IAAI,KAAK,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,MAAM,EAAE,CAAC;oBACvD,KAAK,EAAE,CAAC;oBAER,IAAI,KAAK,GAAG,EAAE,CAAC;oBACf,OAAO,KAAK,GAAG,GAAG,EAAE,CAAC;wBACnB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;wBACxC,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;4BACpB,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;4BACtC,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,SAAS;gCAAE,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;4BAC3D,MAAM;wBACR,CAAC;wBAED,IAAI,IAAI,KAAK,MAAM,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;4BACnC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;4BACzB,SAAS;wBACX,CAAC;wBAED,KAAK,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;oBACrC,CAAC;oBAED,SAAS,SAAS,CAAC;gBACrB,CAAC;gBAED,MAAM,UAAU,GAAG,KAAK,CAAC;gBACzB,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAEtC,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;oBAClC,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;oBACxD,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBACvD,CAAC;gBAED,SAAS,SAAS,CAAC;YACrB,CAAC;YAED,KAAK,EAAE,CAAC;QACV,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,GAAW,EAAE,KAAa,EAAE,GAAW;IACxD,OAAO,KAAK,GAAG,GAAG,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,IAAI;YAAE,MAAM;QACzB,KAAK,EAAE,CAAC;IACV,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,OAAO,CAAC,MAAc,EAAE,KAAa,EAAE,GAAW;IACzD,OAAO,KAAK,GAAG,GAAG,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,IAAI;YAAE,MAAM;QACxC,KAAK,EAAE,CAAC;IACV,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,MAAc,EAAE,KAAa,EAAE,GAAW;IAC7D,OAAO,GAAG,GAAG,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;QACxC,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,IAAI;YAAE,MAAM;QACxC,GAAG,EAAE,CAAC;IACR,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,SAAS,OAAO,CAAC,GAAW;IAC1B,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IACvC,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC;IAE3E,MAAM,IAAI,SAAS,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;AACzD,CAAC","sourcesContent":["/*!\n * content-type\n * Copyright(c) 2015 Douglas Christopher Wilson\n * MIT Licensed\n */\n\nconst TEXT_REGEXP = /^[\\u0009\\u0020-\\u007e\\u0080-\\u00ff]*$/;\nconst TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;\n\n/**\n * RegExp to match chars that must be quoted-pair in RFC 9110 sec 5.6.4\n */\nconst QUOTE_REGEXP = /[\\\\\"]/g;\n\n/**\n * RegExp to match type in RFC 9110 sec 8.3.1\n *\n * media-type = type \"/\" subtype\n * type = token\n * subtype = token\n */\nconst TYPE_REGEXP =\n /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;\n\n/**\n * Null object perf optimization. Faster than `Object.create(null)` and `{ __proto__: null }`.\n */\nconst NullObject = /* @__PURE__ */ (() => {\n const C = function () {};\n C.prototype = Object.create(null);\n return C;\n})() as unknown as { new (): any };\n\n/**\n * The content type object contains a type string and optional parameters.\n */\nexport interface ContentType {\n type: string;\n parameters: Record<string, string>;\n}\n\n/**\n * Format an object into a `Content-Type` header.\n */\nexport function format(obj: Partial<ContentType>): string {\n const { type, parameters } = obj;\n\n if (!type || !TYPE_REGEXP.test(type)) {\n throw new TypeError(`Invalid type: ${type}`);\n }\n\n let result = type;\n\n if (parameters) {\n for (const param of Object.keys(parameters)) {\n if (!TOKEN_REGEXP.test(param)) {\n throw new TypeError(`Invalid parameter name: ${param}`);\n }\n\n result += `; ${param}=${qstring(parameters[param])}`;\n }\n }\n\n return result;\n}\n\n/**\n * Options for parsing a `Content-Type` header.\n */\nexport interface ParseOptions {\n parameters?: boolean;\n}\n\n/**\n * Parse a `Content-Type` header.\n */\nexport function parse(header: string, options?: ParseOptions): ContentType {\n const len = header.length;\n let index = skipOWS(header, 0, len);\n\n const valueStart = index;\n index = skipValue(header, index, len);\n const valueEnd = trailingOWS(header, valueStart, index);\n const type = header.slice(valueStart, valueEnd).toLowerCase();\n const parameters =\n options?.parameters === false\n ? new NullObject()\n : parseParameters(header, index, len);\n\n return { type, parameters };\n}\n\nconst SP = 32; // \" \"\nconst HTAB = 9; // \"\\t\"\nconst SEMI = 59; // \";\"\nconst EQ = 61; // \"=\"\nconst DQUOTE = 34; // '\"'\nconst BSLASH = 92; // \"\\\\\"\n\n/**\n * Parses the parameters of a `Content-Type` header starting at the given index.\n */\nfunction parseParameters(\n header: string,\n index: number,\n len: number,\n): Record<string, string> {\n const parameters: Record<string, string> = new NullObject();\n\n parameter: while (index < len) {\n index = skipOWS(header, index + 1 /* Skip over ; */, len);\n\n const keyStart = index;\n\n while (index < len) {\n const code = header.charCodeAt(index);\n if (code === SEMI) continue parameter;\n\n if (code === EQ) {\n const keyEnd = trailingOWS(header, keyStart, index);\n const key = header.slice(keyStart, keyEnd).toLowerCase();\n\n index = skipOWS(header, index + 1, len);\n\n if (index < len && header.charCodeAt(index) === DQUOTE) {\n index++;\n\n let value = \"\";\n while (index < len) {\n const code = header.charCodeAt(index++);\n if (code === DQUOTE) {\n index = skipValue(header, index, len);\n if (parameters[key] === undefined) parameters[key] = value;\n break;\n }\n\n if (code === BSLASH && index < len) {\n value += header[index++];\n continue;\n }\n\n value += String.fromCharCode(code);\n }\n\n continue parameter;\n }\n\n const valueStart = index;\n index = skipValue(header, index, len);\n\n if (parameters[key] === undefined) {\n const valueEnd = trailingOWS(header, valueStart, index);\n parameters[key] = header.slice(valueStart, valueEnd);\n }\n\n continue parameter;\n }\n\n index++;\n }\n }\n\n return parameters;\n}\n\n/**\n * Skip over characters until a semicolon.\n */\nfunction skipValue(str: string, index: number, len: number): number {\n while (index < len) {\n const char = str.charCodeAt(index);\n if (char === SEMI) break;\n index++;\n }\n return index;\n}\n\n/**\n * Skip optional whitespace (OWS) in an HTTP header value.\n *\n * OWS is defined in RFC 9110 sec 5.6.3 as SP (\" \") or HTAB (\"\\t\").\n */\nfunction skipOWS(header: string, index: number, len: number): number {\n while (index < len) {\n const char = header.charCodeAt(index);\n if (char !== SP && char !== HTAB) break;\n index++;\n }\n return index;\n}\n\n/**\n * Trim optional whitespace (OWS) from the end of a substring.\n *\n * OWS is defined in RFC 9110 sec 5.6.3 as SP (\" \") or HTAB (\"\\t\").\n */\nfunction trailingOWS(header: string, start: number, end: number): number {\n while (end > start) {\n const char = header.charCodeAt(end - 1);\n if (char !== SP && char !== HTAB) break;\n end--;\n }\n return end;\n}\n\n/**\n * Serialize a parameter value.\n */\nfunction qstring(str: string): string {\n if (TOKEN_REGEXP.test(str)) return str;\n if (TEXT_REGEXP.test(str)) return `\"${str.replace(QUOTE_REGEXP, \"\\\\$&\")}\"`;\n\n throw new TypeError(`Invalid parameter value: ${str}`);\n}\n"]}
package/package.json CHANGED
@@ -1,40 +1,52 @@
1
1
  {
2
2
  "name": "content-type",
3
+ "version": "2.0.0",
3
4
  "description": "Create and parse HTTP Content-Type header",
4
- "version": "1.0.4",
5
- "author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
6
- "license": "MIT",
7
5
  "keywords": [
8
6
  "content-type",
9
7
  "http",
10
8
  "req",
11
9
  "res",
12
- "rfc7231"
10
+ "rfc7231",
11
+ "rfc9110"
13
12
  ],
14
13
  "repository": "jshttp/content-type",
15
- "devDependencies": {
16
- "eslint": "3.19.0",
17
- "eslint-config-standard": "10.2.1",
18
- "eslint-plugin-import": "2.7.0",
19
- "eslint-plugin-node": "5.1.1",
20
- "eslint-plugin-promise": "3.5.0",
21
- "eslint-plugin-standard": "3.0.1",
22
- "istanbul": "0.4.5",
23
- "mocha": "~1.21.5"
14
+ "funding": {
15
+ "type": "opencollective",
16
+ "url": "https://opencollective.com/express"
24
17
  },
18
+ "license": "MIT",
19
+ "author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
20
+ "type": "commonjs",
21
+ "exports": "./dist/index.js",
22
+ "main": "./dist/index.js",
23
+ "typings": "./dist/index.d.ts",
25
24
  "files": [
26
- "LICENSE",
27
- "HISTORY.md",
28
- "README.md",
29
- "index.js"
25
+ "dist/"
30
26
  ],
27
+ "scripts": {
28
+ "bench": "vitest bench",
29
+ "build": "ts-scripts build",
30
+ "format": "ts-scripts format",
31
+ "prepare": "ts-scripts install && npm run build",
32
+ "specs": "ts-scripts specs",
33
+ "test": "ts-scripts test"
34
+ },
35
+ "devDependencies": {
36
+ "@borderless/ts-scripts": "^0.15.0",
37
+ "@vitest/coverage-v8": "^3.0.5",
38
+ "typescript": "^5.7.3",
39
+ "vitest": "^3.2.4"
40
+ },
31
41
  "engines": {
32
- "node": ">= 0.6"
42
+ "node": ">=18"
33
43
  },
34
- "scripts": {
35
- "lint": "eslint .",
36
- "test": "mocha --reporter spec --check-leaks --bail test/",
37
- "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
38
- "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/"
44
+ "ts-scripts": {
45
+ "dist": [
46
+ "dist"
47
+ ],
48
+ "project": [
49
+ "tsconfig.build.json"
50
+ ]
39
51
  }
40
52
  }
package/HISTORY.md DELETED
@@ -1,24 +0,0 @@
1
- 1.0.4 / 2017-09-11
2
- ==================
3
-
4
- * perf: skip parameter parsing when no parameters
5
-
6
- 1.0.3 / 2017-09-10
7
- ==================
8
-
9
- * perf: remove argument reassignment
10
-
11
- 1.0.2 / 2016-05-09
12
- ==================
13
-
14
- * perf: enable strict mode
15
-
16
- 1.0.1 / 2015-02-13
17
- ==================
18
-
19
- * Improve missing `Content-Type` header error message
20
-
21
- 1.0.0 / 2015-02-01
22
- ==================
23
-
24
- * Initial implementation, derived from `media-typer@0.3.0`
package/index.js DELETED
@@ -1,222 +0,0 @@
1
- /*!
2
- * content-type
3
- * Copyright(c) 2015 Douglas Christopher Wilson
4
- * MIT Licensed
5
- */
6
-
7
- 'use strict'
8
-
9
- /**
10
- * RegExp to match *( ";" parameter ) in RFC 7231 sec 3.1.1.1
11
- *
12
- * parameter = token "=" ( token / quoted-string )
13
- * token = 1*tchar
14
- * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
15
- * / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
16
- * / DIGIT / ALPHA
17
- * ; any VCHAR, except delimiters
18
- * quoted-string = DQUOTE *( qdtext / quoted-pair ) DQUOTE
19
- * qdtext = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text
20
- * obs-text = %x80-FF
21
- * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
22
- */
23
- var PARAM_REGEXP = /; *([!#$%&'*+.^_`|~0-9A-Za-z-]+) *= *("(?:[\u000b\u0020\u0021\u0023-\u005b\u005d-\u007e\u0080-\u00ff]|\\[\u000b\u0020-\u00ff])*"|[!#$%&'*+.^_`|~0-9A-Za-z-]+) */g
24
- var TEXT_REGEXP = /^[\u000b\u0020-\u007e\u0080-\u00ff]+$/
25
- var TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
26
-
27
- /**
28
- * RegExp to match quoted-pair in RFC 7230 sec 3.2.6
29
- *
30
- * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
31
- * obs-text = %x80-FF
32
- */
33
- var QESC_REGEXP = /\\([\u000b\u0020-\u00ff])/g
34
-
35
- /**
36
- * RegExp to match chars that must be quoted-pair in RFC 7230 sec 3.2.6
37
- */
38
- var QUOTE_REGEXP = /([\\"])/g
39
-
40
- /**
41
- * RegExp to match type in RFC 7231 sec 3.1.1.1
42
- *
43
- * media-type = type "/" subtype
44
- * type = token
45
- * subtype = token
46
- */
47
- var TYPE_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
48
-
49
- /**
50
- * Module exports.
51
- * @public
52
- */
53
-
54
- exports.format = format
55
- exports.parse = parse
56
-
57
- /**
58
- * Format object to media type.
59
- *
60
- * @param {object} obj
61
- * @return {string}
62
- * @public
63
- */
64
-
65
- function format (obj) {
66
- if (!obj || typeof obj !== 'object') {
67
- throw new TypeError('argument obj is required')
68
- }
69
-
70
- var parameters = obj.parameters
71
- var type = obj.type
72
-
73
- if (!type || !TYPE_REGEXP.test(type)) {
74
- throw new TypeError('invalid type')
75
- }
76
-
77
- var string = type
78
-
79
- // append parameters
80
- if (parameters && typeof parameters === 'object') {
81
- var param
82
- var params = Object.keys(parameters).sort()
83
-
84
- for (var i = 0; i < params.length; i++) {
85
- param = params[i]
86
-
87
- if (!TOKEN_REGEXP.test(param)) {
88
- throw new TypeError('invalid parameter name')
89
- }
90
-
91
- string += '; ' + param + '=' + qstring(parameters[param])
92
- }
93
- }
94
-
95
- return string
96
- }
97
-
98
- /**
99
- * Parse media type to object.
100
- *
101
- * @param {string|object} string
102
- * @return {Object}
103
- * @public
104
- */
105
-
106
- function parse (string) {
107
- if (!string) {
108
- throw new TypeError('argument string is required')
109
- }
110
-
111
- // support req/res-like objects as argument
112
- var header = typeof string === 'object'
113
- ? getcontenttype(string)
114
- : string
115
-
116
- if (typeof header !== 'string') {
117
- throw new TypeError('argument string is required to be a string')
118
- }
119
-
120
- var index = header.indexOf(';')
121
- var type = index !== -1
122
- ? header.substr(0, index).trim()
123
- : header.trim()
124
-
125
- if (!TYPE_REGEXP.test(type)) {
126
- throw new TypeError('invalid media type')
127
- }
128
-
129
- var obj = new ContentType(type.toLowerCase())
130
-
131
- // parse parameters
132
- if (index !== -1) {
133
- var key
134
- var match
135
- var value
136
-
137
- PARAM_REGEXP.lastIndex = index
138
-
139
- while ((match = PARAM_REGEXP.exec(header))) {
140
- if (match.index !== index) {
141
- throw new TypeError('invalid parameter format')
142
- }
143
-
144
- index += match[0].length
145
- key = match[1].toLowerCase()
146
- value = match[2]
147
-
148
- if (value[0] === '"') {
149
- // remove quotes and escapes
150
- value = value
151
- .substr(1, value.length - 2)
152
- .replace(QESC_REGEXP, '$1')
153
- }
154
-
155
- obj.parameters[key] = value
156
- }
157
-
158
- if (index !== header.length) {
159
- throw new TypeError('invalid parameter format')
160
- }
161
- }
162
-
163
- return obj
164
- }
165
-
166
- /**
167
- * Get content-type from req/res objects.
168
- *
169
- * @param {object}
170
- * @return {Object}
171
- * @private
172
- */
173
-
174
- function getcontenttype (obj) {
175
- var header
176
-
177
- if (typeof obj.getHeader === 'function') {
178
- // res-like
179
- header = obj.getHeader('content-type')
180
- } else if (typeof obj.headers === 'object') {
181
- // req-like
182
- header = obj.headers && obj.headers['content-type']
183
- }
184
-
185
- if (typeof header !== 'string') {
186
- throw new TypeError('content-type header is missing from object')
187
- }
188
-
189
- return header
190
- }
191
-
192
- /**
193
- * Quote a string if necessary.
194
- *
195
- * @param {string} val
196
- * @return {string}
197
- * @private
198
- */
199
-
200
- function qstring (val) {
201
- var str = String(val)
202
-
203
- // no need to quote tokens
204
- if (TOKEN_REGEXP.test(str)) {
205
- return str
206
- }
207
-
208
- if (str.length > 0 && !TEXT_REGEXP.test(str)) {
209
- throw new TypeError('invalid parameter value')
210
- }
211
-
212
- return '"' + str.replace(QUOTE_REGEXP, '\\$1') + '"'
213
- }
214
-
215
- /**
216
- * Class to represent a content type.
217
- * @private
218
- */
219
- function ContentType (type) {
220
- this.parameters = Object.create(null)
221
- this.type = type
222
- }