Monkey Requests

Useful library for sending requests.

Versión del día 23/6/2020. Echa un vistazo a la versión más reciente.

Este script no debería instalarse directamente. Es una biblioteca que utilizan otros scripts mediante la meta-directiva de inclusión // @require https://update.greasyfork.org/scripts/405822/819506/Monkey%20Requests.js

Tendrás que instalar una extensión para tu navegador como Tampermonkey, Greasemonkey o Violentmonkey si quieres utilizar este script.

You will need to install an extension such as Tampermonkey to install this script.

Tendrás que instalar una extensión como Tampermonkey o Violentmonkey para instalar este script.

Necesitarás instalar una extensión como Tampermonkey o Userscripts para instalar este script.

Tendrás que instalar una extensión como Tampermonkey antes de poder instalar este script.

Necesitarás instalar una extensión para administrar scripts de usuario si quieres instalar este script.

(Ya tengo un administrador de scripts de usuario, déjame instalarlo)

Tendrás que instalar una extensión como Stylus antes de poder instalar este script.

Tendrás que instalar una extensión como Stylus antes de poder instalar este script.

Tendrás que instalar una extensión como Stylus antes de poder instalar este script.

Para poder instalar esto tendrás que instalar primero una extensión de estilos de usuario.

Para poder instalar esto tendrás que instalar primero una extensión de estilos de usuario.

Para poder instalar esto tendrás que instalar primero una extensión de estilos de usuario.

(Ya tengo un administrador de estilos de usuario, déjame instalarlo)

// ==UserScript==
// @name Monkey Requests
// @namespace https://rafaelgssa.gitlab.io/monkey-scripts
// @version 1.0.3
// @author rafaelgssa
// @description Useful library for sending requests.
// @match *://*/*
// @require https://greasemonkey.github.io/gm4-polyfill/gm4-polyfill.js
// @require https://greasyfork.org/scripts/405802-monkey-dom/code/Monkey%20DOM.js
// @require https://greasyfork.org/scripts/405813-monkey-utils/code/Monkey%20Utils.js
// @grant GM.xmlHttpRequest
// @grant GM_xmlhttpRequest
// ==/UserScript==

/* global MonkeyDom, MonkeyUtils */

/**
 * @typedef {'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'} RequestMethod
 * @typedef {Object} MonkeyResponse
 * @property {string} url
 * @property {string} text
 * @property {Object} [json]
 * @property {Document} [dom]
 * @typedef {{ [K in RequestMethod]: (url: string, options?: RequestInit | GM.Request) => Promise<MonkeyResponse> }} ShorthandSend
 */

// eslint-disable-next-line
const MonkeyRequests = (() => {
	/** @type {RequestMethod[]} */
	const methods = ['CONNECT', 'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT', 'TRACE'];

	/**
	 * @param {RequestMethod} method
	 * @param {string} url
	 * @param {RequestInit | GM.Request} [options]
	 * @returns {Promise<MonkeyResponse>}
	 */
	const _sendWithMethod = (method, url, options = {}) => {
		return send(url, { ...options, method });
	};

	/**
	 * @param {string} url
	 * @param {RequestInit | GM.Request} [options]
	 * @returns {Promise<MonkeyResponse>}
	 */
	const send = (url, options = {}) => {
		if (_isInternal(url, options)) {
			return _sendInternal(url, options);
		}
		return _sendExternal(url, options);
	};

	/**
	 * Checks if the request is internal (uses window.fetch) or external (uses GM.xmlHttpRequest to bypass CORS).
	 * @param {string} url
	 * @param {RequestInit | GM.Request} options
	 * @returns {options is RequestInit}
	 */
	// eslint-disable-next-line
	const _isInternal = (url, options) => {
		return url.includes(window.location.host);
	};

	/**
	 * @param {string} url
	 * @param {RequestInit} options
	 * @returns {Promise<MonkeyResponse>}
	 */
	const _sendInternal = async (url, options) => {
		const [internalFetch, internalOptions] = _getInternalObjects(options);
		const fetchResponse = await internalFetch(url, internalOptions);
		/** @type {MonkeyResponse} */
		const response = {
			url: fetchResponse.url,
			text: await fetchResponse.text(),
		};
		return _processResponse(response);
	};

	/**
	 * Allows the request to be made in the current Firefox container.
	 * @param {RequestInit} options
	 * @returns {[Function, RequestInit]}
	 */
	const _getInternalObjects = (options) => {
		if ('wrappedJSObject' in window) {
			window.wrappedJSObject.options = cloneInto(options, window);
			return [window.wrappedJSObject.fetch, window.wrappedJSObject.options];
		}
		return [window.fetch, options];
	};

	/**
	 * @param {string} url
	 * @param {Partial<GM.Request>} options
	 * @returns {Promise<MonkeyResponse>}
	 */
	const _sendExternal = (url, options) => {
		return new Promise((resolve) => {
			GM.xmlHttpRequest({
				url,
				method: 'GET',
				...options,
				onload: (gmResponse) => {
					/** @type {MonkeyResponse} */
					const response = {
						url: gmResponse.finalUrl,
						text: gmResponse.responseText,
					};
					resolve(_processResponse(response));
				},
			});
		});
	};

	/**
	 * @param {MonkeyResponse} response
	 * @returns {MonkeyResponse}
	 */
	const _processResponse = (response) => {
		const processedResponse = { ...response };
		try {
			processedResponse.dom = MonkeyDom.parse(response.text);
		} catch (err) {
			// Response is not a DOM, just ignore.
		}
		try {
			processedResponse.json = JSON.parse(response.text);
		} catch (err) {
			// Response is not a JSON, just ignore.
		}
		return processedResponse;
	};

	/**
	 * Parses a query string into an object.
	 * @param {string} query The query to parse.
	 * @returns {Record<string, string>} The parsed object.
	 */
	const parseQuery = (query) => {
		/** @type {Record<string, string>} */
		const params = {};
		const rawQuery = query.startsWith('?') ? query.slice(1) : query;
		const parts = rawQuery.split('&').filter(MonkeyUtils.isSet);
		for (const part of parts) {
			const [key, value] = part.split('=').filter(MonkeyUtils.isSet);
			params[key] = value;
		}
		return params;
	};

	/**
	 * Converts an object to a query string.
	 * @param {Record<string, unknown>} obj The object to convert.
	 * @returns {string} The converted query string, without '?'.
	 */
	const convertToQuery = (obj) => {
		return Object.entries(obj)
			.map((entry) => entry.join('='))
			.join('&');
	};

	/** @type {ShorthandSend} */
	// @ts-ignore
	const shorthandSend = {};
	for (const method of methods) {
		shorthandSend[method] = _sendWithMethod.bind(null, method);
	}

	return {
		...shorthandSend,
		parseQuery,
		convertToQuery,
		send,
	};
})();