@d1g1tal/media-type 5.0.1 → 6.0.0

package/src/media-type-parameters.js

@@ -1,111 +0,0 @@
-import httpTokenCodePoints from './utils.js';
-
-const matcher = /(["\\])/ug;
-const httpQuotedStringTokenCodePoints = /^[\t\u0020-\u007E\u0080-\u00FF]*$/u;
-
-/**
- * Class representing the parameters for a media type record.
- * This class extends a JavaScript {@link Map}.
- *
- * However, {@link MediaTypeParameters} methods will always interpret their arguments
- * as appropriate for media types, so parameter names will be lowercased,
- * and attempting to set invalid characters will throw an {@link Error}.
- *
- * @extends Map
- * @see https://mimesniff.spec.whatwg.org/#mime-type-essence
- * @see https://mimesniff.spec.whatwg.org/#mime-type-essence-record
- * @see https://mimesniff.spec.whatwg.org/#mime-type-essence-record-creation
- * @see https://mimesniff.spec.whatwg.org/#mime-type-essence-record-creation-algorithm
- * @module {MediaTypeParameters} media-type-parameters
- * @author D1g1talEntr0py <jason.dimeo@gmail.com>
- */
-export default class MediaTypeParameters extends Map {
-	/**
-	 * Create a new MediaTypeParameters instance.
-	 *
-	 * @param {Array<[string, string]>} entries An array of [name, value] tuples.
-	 */
-	constructor(entries = []) {
-		super(entries);
-	}
-
-	/**
-	 * Indicates whether the supplied name and value are valid media type parameters.
-	 *
-	 * @static
-	 * @param {string} name The name of the media type parameter to validate.
-	 * @param {string} value The media type parameter value to validate.
-	 * @returns {boolean} true if the media type parameter is valid, false otherwise.
-	 */
-	static isValid(name, value) {
-		return httpTokenCodePoints.test(name) && httpQuotedStringTokenCodePoints.test(value);
-	}
-
-	/**
-	 * Gets the media type parameter value for the supplied name.
-	 *
-	 * @param {string} name The name of the media type parameter to retrieve.
-	 * @returns {string} The media type parameter value.
-	 */
-	get(name) {
-		return super.get(name.toLowerCase());
-	}
-
-	/**
-	 * Indicates whether the media type parameter with the specified name exists or not.
-	 *
-	 * @param {string} name The name of the media type parameter to check.
-	 * @returns {boolean} true if the media type parameter exists, false otherwise.
-	 */
-	has(name) {
-		return super.has(name.toLowerCase());
-	}
-
-	/**
-	 * Adds a new media type parameter using the specified name and value to the MediaTypeParameters.
-	 * If an parameter with the same name already exists, the parameter will be updated.
-	 *
-	 * @param {string} name The name of the media type parameter to set.
-	 * @param {string} value The media type parameter value.
-	 * @returns {MediaTypeParameters} This instance.
-	 */
-	set(name, value) {
-		if (!MediaTypeParameters.isValid(name, value)) {
-			throw new Error(`Invalid media type parameter name/value: ${name}/${value}`);
-		}
-
-		super.set(name.toLowerCase(), value);
-
-		return this;
-	}
-
-	/**
-	 * Removes the media type parameter using the specified name.
-	 *
-	 * @param {string} name The name of the media type parameter to delete.
-	 * @returns {boolean} true if the parameter existed and has been removed, or false if the parameter does not exist.
-	 */
-	delete(name) {
-		return super.delete(name.toLowerCase());
-	}
-
-	/**
-	 * Returns a string representation of the media type parameters.
-	 *
-	 * @override
-	 * @returns {string} The string representation of the media type parameters.
-	 */
-	toString() {
-		return Array.from(this).map(([ name, value ]) => `;${name}=${!value || !httpTokenCodePoints.test(value) ? `"${value.replace(matcher, '\\$1')}"` : value}`).join('');
-	}
-
-	/**
-	 * Returns the name of this class.
-	 *
-	 * @override
-	 * @returns {string} The name of this class.
-	 */
-	[Symbol.toStringTag]() {
-		return 'MediaTypeParameters';
-	}
-}

package/src/media-type-parser.js

@@ -1,120 +0,0 @@
-import MediaTypeParameters from './media-type-parameters.js';
-import httpTokenCodePoints from './utils.js';
-
-const whitespaceCharacters = [' ', '\t', '\n', '\r'];
-const trailingWhitespace = /[ \t\n\r]+$/u;
-const leadingAndTrailingWhitespace = /^[ \t\n\r]+|[ \t\n\r]+$/ug;
-
-export default class MediaTypeParser {
-	/**
-	 * Function to parse a media type.
-	 *
-	 * @static
-	 * @param {string} input The media type to parse
-	 * @returns {{ type: string, subtype: string, parameters: MediaTypeParameters }} An object populated with the parsed media type properties and any parameters.
-	 */
-	static parse(input) {
-		input = input.replace(leadingAndTrailingWhitespace, '');
-
-		const length = input.length, trim = true, lowerCase = false;
-		let { position, result: type, subtype = '' } = MediaTypeParser.#filterComponent({ input }, '/');
-
-		if (!type.length || position >= length || !httpTokenCodePoints.test(type)) { throw new TypeError(MediaTypeParser.#generateErrorMessage('type', type)) }
-
-		({ position, result: subtype } = MediaTypeParser.#filterComponent({ position: ++position, input, trim }, ';')); // `++position` Skips past "/"
-
-		if (!subtype.length || !httpTokenCodePoints.test(subtype)) { throw new TypeError(MediaTypeParser.#generateErrorMessage('subtype', subtype)) }
-
-		let parameterName = '', parameterValue = null;
-		const parameters = new MediaTypeParameters();
-
-		while (position++ < length) { // `position++` Skips past "/"
-			while (whitespaceCharacters.includes(input[position])) { ++position }
-
-			({ position, result: parameterName } = MediaTypeParser.#filterComponent({ position, input, lowerCase }, ';', '='));
-
-			if (position < length) {
-				if (input[position] == ';') { continue }
-
-				// Skip past "="
-				++position;
-			}
-
-			if (input[position] == '"') {
-				[ parameterValue, position ] = MediaTypeParser.#collectHttpQuotedString(input, position);
-
-				while (position < length && input[position] != ';') { ++position }
-			} else {
-				({ position, result: parameterValue } = MediaTypeParser.#filterComponent({ position, input, lowerCase, trim }, ';'));
-
-				if (!parameterValue) { continue }
-			}
-
-			if (parameterName && MediaTypeParameters.isValid(parameterName, parameterValue) && !parameters.has(parameterName)) {
-				parameters.set(parameterName, parameterValue);
-			}
-		}
-
-		return { type, subtype, parameters };
-	}
-
-	/**
-	 * Filters a component from the input string.
-	 *
-	 * @private
-	 * @static
-	 * @param {Object} options The options.
-	 * @param {number} [options.position] The starting position.
-	 * @param {string} options.input The input string.
-	 * @param {boolean} [options.lowerCase] Indicates whether the result should be lowercased.
-	 * @param {boolean} [options.trim] Indicates whether the result should be trimmed.
-	 * @param {string[]} charactersToFilter The characters to filter.
-	 * @returns {{ position: number, result: string }} An object that includes the resulting string and updated position.
-	 */
-	static #filterComponent({ position = 0, input, lowerCase = true, trim = false }, ...charactersToFilter) {
-		let result = '';
-		for (const length = input.length; position < length && !charactersToFilter.includes(input[position]); position++) {
-			result += input[position];
-		}
-
-		if (lowerCase) { result = result.toLowerCase() }
-		if (trim) { result = result.replace(trailingWhitespace, '') }
-
-		return { position, result };
-	}
-
-	/**
-	 * Collects all the HTTP quoted strings.
-	 * This variant only implements it with the extract-value flag set.
-	 *
-	 * @private
-	 * @static
-	 * @param {string} input The string to process.
-	 * @param {number} position The starting position.
-	 * @returns {Array<string|number>} An array that includes the resulting string and updated position.
-	 */
-	static #collectHttpQuotedString(input, position) {
-		let value = '';
-
-		for (let length = input.length, char; ++position < length;) {
-			if ((char = input[position]) == '"') { break }
-
-			value += char == '\\' && ++position < length ? input[position] : char;
-		}
-
-		return [ value, position ];
-	}
-
-	/**
-	 * Generates an error message.
-	 *
-	 * @private
-	 * @static
-	 * @param {string} component The component name.
-	 * @param {string} value The component value.
-	 * @returns {string} The error message.
-	 */
-	static #generateErrorMessage(component, value) {
-		return `Invalid ${component} "${value}": only HTTP token code points are valid.`;
-	}
-}

package/src/media-type.js

@@ -1,101 +0,0 @@
-import { _type } from '@d1g1tal/chrysalis';
-import MediaTypeParameters from './media-type-parameters.js';
-import MediaTypeParser from './media-type-parser.js';
-
-/**
- * Class used to parse media types.
- *
- * @module {MediaType} media-type
- * @see https://mimesniff.spec.whatwg.org/#understanding-mime-types
- */
-export default class MediaType {
-	/** @type {string} */
-	#type;
-	/** @type {string} */
-	#subtype;
-	/** @type {MediaTypeParameters} */
-	#parameters;
-
-	/**
-	 * Create a new MediaType instance from a string representation.
-	 *
-	 * @param {string} mediaType The media type to parse.
-	 * @param {Object} [parameters] Optional parameters.
-	 */
-	constructor(mediaType, parameters = {}) {
-		if (_type(parameters) != Object) { throw new TypeError('The parameters argument must be an object') }
-		({ type: this.#type, subtype: this.#subtype, parameters: this.#parameters } = MediaTypeParser.parse(mediaType));
-		for (const [ name, value ] of Object.entries(parameters)) { this.#parameters.set(name, value) }
-	}
-
-	static parse(mediaType) {
-		try {	return new MediaType(mediaType) } catch(e) { /* ignore */ }
-
-		return null;
-	}
-
-	/**
-	 * Gets the type.
-	 *
-	 * @returns {string} The type.
-	 */
-	get type() {
-		return this.#type;
-	}
-
-	/**
-	 * Gets the subtype.
-	 *
-	 * @returns {string} The subtype.
-	 */
-	get subtype() {
-		return this.#subtype;
-	}
-
-	/**
-	 * Gets the media type essence (type/subtype).
-	 *
-	 * @returns {string} The media type without any parameters
-	 */
-	get essence() {
-		return `${this.#type}/${this.#subtype}`;
-	}
-
-	/**
-	 * Gets the parameters.
-	 *
-	 * @returns {MediaTypeParameters} The media type parameters.
-	 */
-	get parameters() {
-		return this.#parameters;
-	}
-
-	/**
-	 * Checks if the media type matches the specified type.
-	 *
-	 * @todo Fix string handling to parse the type and subtype from the string.
-	 * @param {MediaType|string} mediaType The media type to check.
-	 * @returns {boolean} true if the media type matches the specified type, false otherwise.
-	 */
-	matches(mediaType) {
-		return (this.#type === mediaType?.type && this.#subtype === mediaType?.subtype) || this.essence.includes(mediaType);
-	}
-
-	/**
-	 * Gets the serialized version of the media type.
-	 *
-	 * @returns {string} The serialized media type.
-	 */
-	toString() {
-		return `${this.essence}${this.#parameters.toString()}`;
-	}
-
-	/**
-	 * Gets the name of the class.
-	 *
-	 * @returns {string} The class name
-	 */
-	get [Symbol.toStringTag]() {
-		return 'MediaType';
-	}
-}

package/src/utils.js

@@ -1,3 +0,0 @@
-const httpTokenCodePoints = /^[-!#$%&'*+.^_`|~A-Za-z0-9]*$/u;
-
-export default httpTokenCodePoints;