@d1g1tal/media-type 4.1.0 → 5.0.0

package/LICENSE.txt

@@ -1,7 +1,12 @@
-Copyright © Domenic Denicola <d@domenic.me>
+Copyright (c) 2023, Jason DiMeo
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided
+that the above copyright notice and this permission notice appear in all copies.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Source: http://opensource.org/licenses/ISC

package/README.md

@@ -5,23 +5,23 @@ This package will parse [MIME types](https://mimesniff.spec.whatwg.org/#understa
 This version is using ES Modules instead of commonJS.
 
 ```js
-import { MediaType } from '@d1g1tal/media-type';
+import MediaType from '@d1g1tal/media-type';
 
-const mediaType = new MediaType(`Text/HTML;Charset="utf-8"`);
+const mediaType = new MediaType('Text/HTML;Charset="utf-8"');
 
-console.assert(mediaType.toString() === "text/html;charset=utf-8");
+console.assert(mediaType.toString() == 'text/html;charset=utf-8');
 
-console.assert(mediaType.type === "text");
-console.assert(mediaType.subtype === "html");
-console.assert(mediaType.essence === "text/html");
-console.assert(mediaType.parameters.get("charset") === "utf-8");
+console.assert(mediaType.type == 'text');
+console.assert(mediaType.subtype == 'html');
+console.assert(mediaType.essence == 'text/html');
+console.assert(mediaType.parameters.get('charset') == 'utf-8');
 
-mediaType.parameters.set("charset", "windows-1252");
-console.assert(mediaType.parameters.get("charset") === "windows-1252");
-console.assert(mediaType.toString() === "text/html;charset=windows-1252");
-
-console.assert(mediaType.isHTML() === true);
-console.assert(mediaType.isXML() === false);
+mediaType.parameters.set('charset', 'windows-1252');
+console.assert(mediaType.parameters.get('charset') == 'windows-1252');
+console.assert(mediaType.toString() == 'text/html;charset=windows-1252');
+// Still considering changing this to maybe 'includes' or 'contains'
+console.assert(mediaType.matches('html') == true);
+console.assert(mediaType.matches('xml') == false);
 ```
 
 Parsing is a fairly complex process; see [the specification](https://mimesniff.spec.whatwg.org/#parsing-a-mime-type) for details (and similarly [for serialization](https://mimesniff.spec.whatwg.org/#serializing-a-mime-type)).
@@ -38,9 +38,9 @@ As an alternative to the constructor, you can use `MediaType.parse(string)`. The
 
 ### Properties
 
-- `type`: the media type's [type](https://mimesniff.spec.whatwg.org/#mime-type-type), e.g. `"text"`
-- `subtype`: the media type's [subtype](https://mimesniff.spec.whatwg.org/#mime-type-subtype), e.g. `"html"`
-- `essence`: the media type's [essence](https://mimesniff.spec.whatwg.org/#mime-type-essence), e.g. `"text/html"`
+- `type`: the media type's [type](https://mimesniff.spec.whatwg.org/#mime-type-type), e.g. `'text'`
+- `subtype`: the media type's [subtype](https://mimesniff.spec.whatwg.org/#mime-type-subtype), e.g. `'html'`
+- `essence`: the media type's [essence](https://mimesniff.spec.whatwg.org/#mime-type-essence), e.g. `'text/html'`
 - `parameters`: an instance of `MediaTypeParameters`, containing this media type's [parameters](https://mimesniff.spec.whatwg.org/#mime-type-parameters)
 
 `type` and `subtype` can be changed. They will be validated to be non-empty and only contain [HTTP token code points](https://mimesniff.spec.whatwg.org/#http-token-code-point).
@@ -52,52 +52,35 @@ As an alternative to the constructor, you can use `MediaType.parse(string)`. The
 ### Methods
 
 - `toString()` serializes the media type to a string
-- `isHTML()`: returns true if this instance represents [a HTML media type](https://mimesniff.spec.whatwg.org/#html-mime-type)
-- `isXML()`: returns true if this instance represents [an XML media type](https://mimesniff.spec.whatwg.org/#xml-mime-type)
-- `isJavaScript({ prohibitParameters })`: returns true if this instance represents [a JavaScript media type](https://html.spec.whatwg.org/multipage/scripting.html#javascript-mime-type). `prohibitParameters` can be set to true to disallow any parameters, i.e. to test if the media type's serialization is a [JavaScript media type essence match](https://mimesniff.spec.whatwg.org/#javascript-mime-type-essence-match).
-
-_Note: the `isHTML()`, `isXML()`, and `isJavaScript()` methods are speculative, and may be removed or changed in future major versions. See [whatwg/mimesniff#48](https://github.com/whatwg/mimesniff/issues/48) for brainstorming in this area. Currently we implement these mainly because they are useful in jsdom._
+- `matches(MediaType|string)`: Checks if the media type matches the specified type.
 
 ## `MediaTypeParameters` API
 
-The `MediaTypeParameters` class, instances of which are returned by `MediaType.parameters`, has equivalent surface API to a [JavaScript `Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map).
+The `MediaTypeParameters` class, instances of which are returned by `MediaType.parameters`, extends a [JavaScript `Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) with both the keys and values being strings. The keys are parameter names, and the values are parameter values.
 
 However, `MediaTypeParameters` methods will always interpret their arguments as appropriate for media types, so e.g. parameter names will be lowercased, and attempting to set invalid characters will throw.
 
 Some examples:
 
 ```js
-const mediaType = new MediaType(`x/x;a=b;c=D;E="F"`);
+const mediaType = new MediaType(`x/x;a=b;c=D;E='F'`);
 
 // Logs:
 // a b
 // c D
 // e F
-for (const [name, value] of mediaType.parameters) {
+for (const [ name, value ] of mediaType.parameters) {
   console.log(name, value);
 }
 
-console.assert(mediaType.parameters.has("a"));
-console.assert(mediaType.parameters.has("A"));
-console.assert(mediaType.parameters.get("A") === "b");
+console.assert(mediaType.parameters.has('a'));
+console.assert(mediaType.parameters.has('A'));
+console.assert(mediaType.parameters.get('A') === 'b');
 
-mediaType.parameters.set("Q", "X");
-console.assert(mediaType.parameters.get("q") === "X");
-console.assert(mediaType.toString() === "x/x;a=b;c=d;e=F;q=X");
+mediaType.parameters.set('Q', 'X');
+console.assert(mediaType.parameters.get('q') === 'X');
+console.assert(mediaType.toString() === 'x/x;a=b;c=d;e=F;q=X');
 
 // Throws:
-mediaType.parameters.set("@", "x");
-```
-
-## Raw parsing/serialization APIs
-
-If you want primitives on which to build your own API, you can get direct access to the parsing and serialization algorithms as follows:
-
-```js
-import { parse } from '@d1g1tal/media-type';
-import { serialize } from '@d1g1tal/media-type';
-```
-
-`parse(string)` returns an object containing the `type` and `subtype` strings, plus `parameters`, which is a `Map`. This is roughly our equivalent of the spec's [MIME type record](https://mimesniff.spec.whatwg.org/#mime-type). If parsing fails, it instead returns `null`.
-
-`serialize(record)` operates on the such an object, giving back a string according to the serialization algorithm.
+mediaType.parameters.set('@', 'x');
+```