steamcommunity 3.46.0 → 3.47.0

package/components/help.js

@@ -1,64 +1,64 @@
-const SteamCommunity = require('../index.js');
-
-const Helpers = require('./helpers.js');
-
-const HELP_SITE_DOMAIN = 'https://help.steampowered.com';
-
-/**
- * Restore a previously removed steam package from your steam account.
- * @param {int|string} packageID
- * @param {function} callback
- */
-SteamCommunity.prototype.restorePackage = function(packageID, callback) {
-	this.httpRequestPost({
-		uri: HELP_SITE_DOMAIN + '/wizard/AjaxDoPackageRestore',
-		form: {
-			packageid: packageID,
-			sessionid: this.getSessionID(HELP_SITE_DOMAIN),
-			wizard_ajax: 1
-		},
-		json: true
-	}, wizardAjaxHandler(callback));
-};
-
-/**
- * Remove a steam package from your steam account.
- * @param {int|string} packageID
- * @param {function} callback
- */
-SteamCommunity.prototype.removePackage = function(packageID, callback) {
-	this.httpRequestPost({
-		uri: HELP_SITE_DOMAIN + '/wizard/AjaxDoPackageRemove',
-		form: {
-			packageid: packageID,
-			sessionid: this.getSessionID(HELP_SITE_DOMAIN),
-			wizard_ajax: 1
-		},
-		json: true
-	}, wizardAjaxHandler(callback));
-};
-
-/**
- * Returns a handler for wizard ajax HTTP requests.
- * @param {function} callback
- * @returns {(function(*=, *, *): void)|*}
- */
-function wizardAjaxHandler(callback) {
-	return (err, res, body) => {
-		if (!callback) {
-			return;
-		}
-
-		if (err) {
-			callback(err);
-			return;
-		}
-
-		if (!body.success) {
-			callback(body.errorMsg ? new Error(body.errorMsg) : Helpers.eresultError(body.success));
-			return;
-		}
-
-		callback(null);
-	};
-}
+const SteamCommunity = require('../index.js');
+
+const Helpers = require('./helpers.js');
+
+const HELP_SITE_DOMAIN = 'https://help.steampowered.com';
+
+/**
+ * Restore a previously removed steam package from your steam account.
+ * @param {int|string} packageID
+ * @param {function} callback
+ */
+SteamCommunity.prototype.restorePackage = function(packageID, callback) {
+	this.httpRequestPost({
+		uri: HELP_SITE_DOMAIN + '/wizard/AjaxDoPackageRestore',
+		form: {
+			packageid: packageID,
+			sessionid: this.getSessionID(HELP_SITE_DOMAIN),
+			wizard_ajax: 1
+		},
+		json: true
+	}, wizardAjaxHandler(callback));
+};
+
+/**
+ * Remove a steam package from your steam account.
+ * @param {int|string} packageID
+ * @param {function} callback
+ */
+SteamCommunity.prototype.removePackage = function(packageID, callback) {
+	this.httpRequestPost({
+		uri: HELP_SITE_DOMAIN + '/wizard/AjaxDoPackageRemove',
+		form: {
+			packageid: packageID,
+			sessionid: this.getSessionID(HELP_SITE_DOMAIN),
+			wizard_ajax: 1
+		},
+		json: true
+	}, wizardAjaxHandler(callback));
+};
+
+/**
+ * Returns a handler for wizard ajax HTTP requests.
+ * @param {function} callback
+ * @returns {(function(*=, *, *): void)|*}
+ */
+function wizardAjaxHandler(callback) {
+	return (err, res, body) => {
+		if (!callback) {
+			return;
+		}
+
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if (!body.success) {
+			callback(body.errorMsg ? new Error(body.errorMsg) : Helpers.eresultError(body.success));
+			return;
+		}
+
+		callback(null);
+	};
+}

package/components/helpers.js

@@ -1,108 +1,128 @@
-const EResult = require('../resources/EResult.js');
-const request = require('request');
-const xml2js  = require('xml2js');
-
-exports.isSteamID = function(input) {
-	var keys = Object.keys(input);
-	if (keys.length != 4) {
-		return false;
-	}
-
-	// Make sure it has the keys we expect
-	keys = keys.filter(function(item) {
-		return ['universe', 'type', 'instance', 'accountid'].indexOf(item) != -1;
-	});
-
-	return keys.length == 4;
-};
-
-exports.decodeSteamTime = function(time) {
-	var date = new Date();
-
-	if (time.includes("@")) {
-		var parts = time.split('@');
-		if (!parts[0].includes(",")) {
-			// no year, assume current year
-			parts[0] += ", " + date.getFullYear();
-		}
-
-		date = new Date(parts.join('@').replace(/(am|pm)/, ' $1') + " UTC");  // add a space so JS can decode it
-	} else {
-		// Relative date
-		var amount = time.replace(/(\d) (minutes|hour|hours) ago/, "$1");
-
-		if(time.includes("minutes")) {
-			date.setMinutes(date.getMinutes() - amount);
-		} else if(time.match(/hour|hours/)) {
-			date.setHours(date.getHours() - amount);
-		}
-	}
-
-	return date;
-};
-
-/**
- * Get an Error object for a particular EResult
- * @param {int} eresult
- * @returns {null|Error}
- */
-exports.eresultError = function(eresult) {
-	if (eresult == EResult.OK) {
-		// no error
-		return null;
-	}
-
-	var err = new Error(EResult[eresult] || ("Error " + eresult));
-	err.eresult = eresult;
-	return err;
-};
-
-exports.decodeJwt = function(jwt) {
-	let parts = jwt.split('.');
-	if (parts.length != 3) {
-		throw new Error('Invalid JWT');
-	}
-
-	let standardBase64 = parts[1].replace(/-/g, '+')
-		.replace(/_/g, '/');
-
-	return JSON.parse(Buffer.from(standardBase64, 'base64').toString('utf8'));
-};
-
-/**
- * Resolves a Steam profile URL to get steamID64 and vanityURL
- * @param {String} url - Full steamcommunity profile URL or only the vanity part.
- * @param {Object} callback - First argument is null/Error, second is object containing vanityURL (String) and steamID (String)
- */
-exports.resolveVanityURL = function(url, callback) {
-	// Precede url param if only the vanity was provided
-	if (!url.includes("steamcommunity.com")) {
-		url = "https://steamcommunity.com/id/" + url;
-	}
-
-	// Make request to get XML data
-	request(url + "/?xml=1", function(err, response, body) {
-		if (err) {
-			callback(err);
-			return;
-		}
-
-		// Parse XML data returned from Steam into an object
-		new xml2js.Parser().parseString(body, (err, parsed) => {
-			if (err) {
-				callback(new Error("Couldn't parse XML response"));
-				return;
-			}
-
-			if (parsed.response && parsed.response.error) {
-				callback(new Error("Couldn't find Steam ID"));
-				return;
-			}
-
-			let steamID64 = parsed.profile.steamID64;
-			let vanityURL = parsed.profile.customURL;
-
-			callback(null, {"vanityURL": vanityURL, "steamID": steamID64});
-		});
-	});
-};
+const request = require('request');
+const SteamID = require('steamid');
+const xml2js  = require('xml2js');
+
+const EResult = require('../resources/EResult.js');
+
+exports.isSteamID = function(input) {
+	var keys = Object.keys(input);
+	if (keys.length != 4) {
+		return false;
+	}
+
+	// Make sure it has the keys we expect
+	keys = keys.filter(function(item) {
+		return ['universe', 'type', 'instance', 'accountid'].indexOf(item) != -1;
+	});
+
+	return keys.length == 4;
+};
+
+exports.decodeSteamTime = function(time) {
+	var date = new Date();
+
+	if (time.includes("@")) {
+		var parts = time.split('@');
+		if (!parts[0].includes(",")) {
+			// no year, assume current year
+			parts[0] += ", " + date.getFullYear();
+		}
+
+		date = new Date(parts.join('@').replace(/(am|pm)/, ' $1') + " UTC");  // add a space so JS can decode it
+	} else {
+		// Relative date
+		var amount = time.replace(/(\d) (minutes|hour|hours) ago/, "$1");
+
+		if(time.includes("minutes")) {
+			date.setMinutes(date.getMinutes() - amount);
+		} else if(time.match(/hour|hours/)) {
+			date.setHours(date.getHours() - amount);
+		}
+	}
+
+	return date;
+};
+
+/**
+ * Get an Error object for a particular EResult
+ * @param {int} eresult
+ * @returns {null|Error}
+ */
+exports.eresultError = function(eresult) {
+	if (eresult == EResult.OK) {
+		// no error
+		return null;
+	}
+
+	var err = new Error(EResult[eresult] || ("Error " + eresult));
+	err.eresult = eresult;
+	return err;
+};
+
+exports.decodeJwt = function(jwt) {
+	let parts = jwt.split('.');
+	if (parts.length != 3) {
+		throw new Error('Invalid JWT');
+	}
+
+	let standardBase64 = parts[1].replace(/-/g, '+')
+		.replace(/_/g, '/');
+
+	return JSON.parse(Buffer.from(standardBase64, 'base64').toString('utf8'));
+};
+
+/**
+ * Resolves a Steam profile URL to get steamID64 and vanityURL
+ * @param {String} url - Full steamcommunity profile URL or only the vanity part.
+ * @param {Object} callback - First argument is null/Error, second is object containing vanityURL (String) and steamID (String)
+ */
+exports.resolveVanityURL = function(url, callback) {
+	// Precede url param if only the vanity was provided
+	if (!url.includes("steamcommunity.com")) {
+		url = "https://steamcommunity.com/id/" + url;
+	}
+
+	// Make request to get XML data
+	request(url + "/?xml=1", function(err, response, body) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		// Parse XML data returned from Steam into an object
+		new xml2js.Parser().parseString(body, (err, parsed) => {
+			if (err) {
+				callback(new Error("Couldn't parse XML response"));
+				return;
+			}
+
+			if (parsed.response && parsed.response.error) {
+				callback(new Error("Couldn't find Steam ID"));
+				return;
+			}
+
+			let steamID64 = parsed.profile.steamID64[0];
+			let vanityURL = parsed.profile.customURL[0];
+
+			callback(null, {"vanityURL": vanityURL, "steamID": steamID64});
+		});
+	});
+};
+
+/**
+ * Converts `input` into a SteamID object, if it's a parseable string.
+ * @param {SteamID|string} input
+ * @return {SteamID}
+ */
+exports.steamID = function(input) {
+	if (exports.isSteamID(input)) {
+		return input;
+	}
+
+	if (typeof input != 'string') {
+		throw new Error(`Input SteamID value "${input}" is not a string`);
+	}
+
+	// This will throw if the input is not a well-formed SteamID
+	return new SteamID(input);
+};

package/components/http.js

@@ -1,150 +1,150 @@
-var SteamCommunity = require('../index.js');
-
-SteamCommunity.prototype.httpRequest = function(uri, options, callback, source) {
-	if (typeof uri === 'object') {
-		source = callback;
-		callback = options;
-		options = uri;
-		uri = options.url || options.uri;
-	} else if (typeof options === 'function') {
-		source = callback;
-		callback = options;
-		options = {};
-	}
-
-	options.url = options.uri = uri;
-
-	if (this._httpRequestConvenienceMethod) {
-		options.method = this._httpRequestConvenienceMethod;
-		delete this._httpRequestConvenienceMethod;
-	}
-
-	var requestID = ++this._httpRequestID;
-	source = source || "";
-
-	var self = this;
-	var continued = false;
-
-	if (!this.onPreHttpRequest || !this.onPreHttpRequest(requestID, source, options, continueRequest)) {
-		// No pre-hook, or the pre-hook doesn't want to delay the request.
-		continueRequest(null);
-	}
-
-	function continueRequest(err) {
-		if (continued) {
-			return;
-		}
-
-		continued = true;
-
-		if (err) {
-			if (callback) {
-				callback(err);
-			}
-
-			return;
-		}
-
-		self.request(options, function (err, response, body) {
-			var hasCallback = !!callback;
-			var httpError = options.checkHttpError !== false && self._checkHttpError(err, response, callback, body);
-			var communityError = !options.json && options.checkCommunityError !== false && self._checkCommunityError(body, httpError ? function () {} : callback); // don't fire the callback if hasHttpError did it already
-			var tradeError = !options.json && options.checkTradeError !== false && self._checkTradeError(body, httpError || communityError ? function () {} : callback); // don't fire the callback if either of the previous already did
-			var jsonError = options.json && options.checkJsonError !== false && !body ? new Error("Malformed JSON response") : null;
-
-			self.emit('postHttpRequest', requestID, source, options, httpError || communityError || tradeError || jsonError || null, response, body, {
-				"hasCallback": hasCallback,
-				"httpError": httpError,
-				"communityError": communityError,
-				"tradeError": tradeError,
-				"jsonError": jsonError
-			});
-
-			if (hasCallback && !(httpError || communityError || tradeError)) {
-				if (jsonError) {
-					callback.call(self, jsonError, response);
-				} else {
-					callback.apply(self, arguments);
-				}
-			}
-		});
-	}
-};
-
-SteamCommunity.prototype.httpRequestGet = function() {
-	this._httpRequestConvenienceMethod = "GET";
-	return this.httpRequest.apply(this, arguments);
-};
-
-SteamCommunity.prototype.httpRequestPost = function() {
-	this._httpRequestConvenienceMethod = "POST";
-	return this.httpRequest.apply(this, arguments);
-};
-
-SteamCommunity.prototype._notifySessionExpired = function(err) {
-	this.emit('sessionExpired', err);
-};
-
-SteamCommunity.prototype._checkHttpError = function(err, response, callback, body) {
-	if (err) {
-		callback(err, response, body);
-		return err;
-	}
-
-	if (response.statusCode >= 300 && response.statusCode <= 399 && response.headers.location.indexOf('/login') != -1) {
-		err = new Error("Not Logged In");
-		callback(err, response, body);
-		this._notifySessionExpired(err);
-		return err;
-	}
-
-	if (response.statusCode == 403 && typeof response.body === 'string' && response.body.match(/<div id="parental_notice_instructions">Enter your PIN below to exit Family View.<\/div>/)) {
-		err = new Error("Family View Restricted");
-		callback(err, response, body);
-		return err;
-	}
-
-	if (response.statusCode >= 400) {
-		err = new Error("HTTP error " + response.statusCode);
-		err.code = response.statusCode;
-		callback(err, response, body);
-		return err;
-	}
-
-	return false;
-};
-
-SteamCommunity.prototype._checkCommunityError = function(html, callback) {
-	var err;
-
-	if(typeof html === 'string' && html.match(/<h1>Sorry!<\/h1>/)) {
-		var match = html.match(/<h3>(.+)<\/h3>/);
-		err = new Error(match ? match[1] : "Unknown error occurred");
-		callback(err);
-		return err;
-	}
-
-	if (typeof html === 'string' && html.indexOf('g_steamID = false;') > -1 && html.indexOf('<title>Sign In</title>') > -1) {
-		err = new Error("Not Logged In");
-		callback(err);
-		this._notifySessionExpired(err);
-		return err;
-	}
-
-	return false;
-};
-
-SteamCommunity.prototype._checkTradeError = function(html, callback) {
-	if (typeof html !== 'string') {
-		return false;
-	}
-
-	var match = html.match(/<div id="error_msg">\s*([^<]+)\s*<\/div>/);
-	if (match) {
-		var err = new Error(match[1].trim());
-		callback(err);
-		return err;
-	}
-
-	return false;
-};
+var SteamCommunity = require('../index.js');
+
+SteamCommunity.prototype.httpRequest = function(uri, options, callback, source) {
+	if (typeof uri === 'object') {
+		source = callback;
+		callback = options;
+		options = uri;
+		uri = options.url || options.uri;
+	} else if (typeof options === 'function') {
+		source = callback;
+		callback = options;
+		options = {};
+	}
+
+	options.url = options.uri = uri;
+
+	if (this._httpRequestConvenienceMethod) {
+		options.method = this._httpRequestConvenienceMethod;
+		delete this._httpRequestConvenienceMethod;
+	}
+
+	var requestID = ++this._httpRequestID;
+	source = source || "";
+
+	var self = this;
+	var continued = false;
+
+	if (!this.onPreHttpRequest || !this.onPreHttpRequest(requestID, source, options, continueRequest)) {
+		// No pre-hook, or the pre-hook doesn't want to delay the request.
+		continueRequest(null);
+	}
+
+	function continueRequest(err) {
+		if (continued) {
+			return;
+		}
+
+		continued = true;
+
+		if (err) {
+			if (callback) {
+				callback(err);
+			}
+
+			return;
+		}
+
+		self.request(options, function (err, response, body) {
+			var hasCallback = !!callback;
+			var httpError = options.checkHttpError !== false && self._checkHttpError(err, response, callback, body);
+			var communityError = !options.json && options.checkCommunityError !== false && self._checkCommunityError(body, httpError ? function () {} : callback); // don't fire the callback if hasHttpError did it already
+			var tradeError = !options.json && options.checkTradeError !== false && self._checkTradeError(body, httpError || communityError ? function () {} : callback); // don't fire the callback if either of the previous already did
+			var jsonError = options.json && options.checkJsonError !== false && !body ? new Error("Malformed JSON response") : null;
+
+			self.emit('postHttpRequest', requestID, source, options, httpError || communityError || tradeError || jsonError || null, response, body, {
+				"hasCallback": hasCallback,
+				"httpError": httpError,
+				"communityError": communityError,
+				"tradeError": tradeError,
+				"jsonError": jsonError
+			});
+
+			if (hasCallback && !(httpError || communityError || tradeError)) {
+				if (jsonError) {
+					callback.call(self, jsonError, response);
+				} else {
+					callback.apply(self, arguments);
+				}
+			}
+		});
+	}
+};
+
+SteamCommunity.prototype.httpRequestGet = function() {
+	this._httpRequestConvenienceMethod = "GET";
+	return this.httpRequest.apply(this, arguments);
+};
+
+SteamCommunity.prototype.httpRequestPost = function() {
+	this._httpRequestConvenienceMethod = "POST";
+	return this.httpRequest.apply(this, arguments);
+};
+
+SteamCommunity.prototype._notifySessionExpired = function(err) {
+	this.emit('sessionExpired', err);
+};
+
+SteamCommunity.prototype._checkHttpError = function(err, response, callback, body) {
+	if (err) {
+		callback(err, response, body);
+		return err;
+	}
+
+	if (response.statusCode >= 300 && response.statusCode <= 399 && response.headers.location.indexOf('/login') != -1) {
+		err = new Error("Not Logged In");
+		callback(err, response, body);
+		this._notifySessionExpired(err);
+		return err;
+	}
+
+	if (response.statusCode == 403 && typeof response.body === 'string' && response.body.match(/<div id="parental_notice_instructions">Enter your PIN below to exit Family View.<\/div>/)) {
+		err = new Error("Family View Restricted");
+		callback(err, response, body);
+		return err;
+	}
+
+	if (response.statusCode >= 400) {
+		err = new Error("HTTP error " + response.statusCode);
+		err.code = response.statusCode;
+		callback(err, response, body);
+		return err;
+	}
+
+	return false;
+};
+
+SteamCommunity.prototype._checkCommunityError = function(html, callback) {
+	var err;
+
+	if(typeof html === 'string' && html.match(/<h1>Sorry!<\/h1>/)) {
+		var match = html.match(/<h3>(.+)<\/h3>/);
+		err = new Error(match ? match[1] : "Unknown error occurred");
+		callback(err);
+		return err;
+	}
+
+	if (typeof html === 'string' && html.indexOf('g_steamID = false;') > -1 && html.indexOf('<title>Sign In</title>') > -1) {
+		err = new Error("Not Logged In");
+		callback(err);
+		this._notifySessionExpired(err);
+		return err;
+	}
+
+	return false;
+};
+
+SteamCommunity.prototype._checkTradeError = function(html, callback) {
+	if (typeof html !== 'string') {
+		return false;
+	}
+
+	var match = html.match(/<div id="error_msg">\s*([^<]+)\s*<\/div>/);
+	if (match) {
+		var err = new Error(match[1].trim());
+		callback(err);
+		return err;
+	}
+
+	return false;
+};