3.30.4

Display Steam error message when available instead of "HTTP error 500"

classes/CEconItem.js

@@ -1,31 +1,40 @@
 module.exports = CEconItem;
 
-function CEconItem(item, descriptions, contextID) {
+function CEconItem(item, description, contextID) {
 	var thing;
-	for(thing in item) {
-		if(item.hasOwnProperty(thing)) {
+	for (thing in item) {
+		if (item.hasOwnProperty(thing)) {
 			this[thing] = item[thing];
 		}
 	}
 
-	this.assetid = this.id = (this.id || this.assetid);
+	var isCurrency = !!(this.is_currency || this.currency) || typeof this.currencyid !== 'undefined'; // I don't want to put this on the object yet; it's nice to have the ids at the top of printed output
+
+	if (isCurrency) {
+		this.currencyid = this.id = (this.id || this.currencyid);
+	} else {
+		this.assetid = this.id = (this.id || this.assetid);
+	}
+
 	this.instanceid = this.instanceid || '0';
 	this.amount = parseInt(this.amount, 10);
 	this.contextid = this.contextid || contextID.toString();
 
 	// Merge the description
-	if(descriptions) {
-		var description = descriptions[this.classid + '_' + this.instanceid];
-		if(description) {
-			for(thing in description) {
-				if(description.hasOwnProperty(thing)) {
-					this[thing] = description[thing];
-				}
+	if (description) {
+		// Is this a listing of descriptions?
+		if (description[this.classid + '_' + this.instanceid]) {
+			description = description[this.classid + '_' + this.instanceid];
+		}
+
+		for (thing in description) {
+			if (description.hasOwnProperty(thing)) {
+				this[thing] = description[thing];
 			}
 		}
 	}
 
-	this.is_currency = !!this.is_currency;
+	this.is_currency = isCurrency;
 	this.tradable = !!this.tradable;
 	this.marketable = !!this.marketable;
 	this.commodity = !!this.commodity;
@@ -34,9 +43,34 @@ function CEconItem(item, descriptions, contextID) {
 	this.fraudwarnings = this.fraudwarnings || [];
 	this.descriptions = this.descriptions || [];
 
-	if(this.owner && JSON.stringify(this.owner) == '{}') {
+	if (this.owner && JSON.stringify(this.owner) == '{}') {
 		this.owner = null;
 	}
+
+	// Restore old property names of tags
+	if (this.tags) {
+		this.tags = this.tags.map(function(tag) {
+			return {
+				"internal_name": tag.internal_name,
+				"name": tag.localized_tag_name || tag.name,
+				"category": tag.category,
+				"color": tag.color || "",
+				"category_name": tag.localized_category_name || tag.category_name
+			};
+		});
+	}
+
+	// Restore market_fee_app, if applicable
+	var match;
+	if (this.appid == 753 && this.contextid == 6 && this.market_hash_name && (match = this.market_hash_name.match(/^(\d+)\-/))) {
+		this.market_fee_app = parseInt(match[1], 10);
+	}
+
+	if (this.actions === "") {
+		this.actions = [];
+	}
+
+	 delete this.currency;
 }
 
 CEconItem.prototype.getImageURL = function() {
@@ -52,12 +86,12 @@ CEconItem.prototype.getLargeImageURL = function() {
 };
 
 CEconItem.prototype.getTag = function(category) {
-	if(!this.tags) {
+	if (!this.tags) {
 		return null;
 	}
 
-	for(var i = 0; i < this.tags.length; i++) {
-		if(this.tags[i].category == category) {
+	for (var i = 0; i < this.tags.length; i++) {
+		if (this.tags[i].category == category) {
 			return this.tags[i];
 		}
 	}

classes/CSteamUser.js

@@ -108,6 +108,8 @@ function CSteamUser(community, userData, customurl) {
 CSteamUser.getAvatarURL = function(hash, size, protocol) {
 	size = size || '';
 	protocol = protocol || 'http://';
+
+	hash = hash || "72f78b4c8cc1f62323f8a33f6d53e27db57c2252"; // The default "?" avatar
 	
 	var url = protocol + "steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/" + hash.substring(0, 2) + "/" + hash;
 	if(size == 'full' || size == 'medium') {
@@ -158,6 +160,25 @@ CSteamUser.prototype.getInventoryContexts = function(callback) {
 	this._community.getUserInventoryContexts(this.steamID, callback);
 };
 
+/**
+ * Get the contents of a user's inventory context.
+ * @deprecated Use CSteamUser#getInventoryContents instead
+ * @param {int} appID - The Steam application ID of the game for which you want an inventory
+ * @param {int} contextID - The ID of the "context" within the game you want to retrieve
+ * @param {boolean} tradableOnly - true to get only tradable items and currencies
+ * @param callback
+ */
 CSteamUser.prototype.getInventory = function(appID, contextID, tradableOnly, callback) {
 	this._community.getUserInventory(this.steamID, appID, contextID, tradableOnly, callback);
 };
+
+/**
+ * Get the contents of a user's inventory context.
+ * @param {int} appID - The Steam application ID of the game for which you want an inventory
+ * @param {int} contextID - The ID of the "context" within the game you want to retrieve
+ * @param {boolean} tradableOnly - true to get only tradable items and currencies
+ * @param callback
+ */
+CSteamUser.prototype.getInventoryContents = function(appID, contextID, tradableOnly, callback) {
+	this._community.getUserInventoryContents(this.steamID, appID, contextID, tradableOnly, callback);
+};

components/confirmations.js

@@ -113,7 +113,7 @@ SteamCommunity.prototype.getConfirmationOfferID = function(confID, time, key, ca
  * @param {int|int[]} confID - The ID of the confirmation in question, or an array of confirmation IDs
  * @param {string|string[]} confKey - The confirmation key associated with the confirmation in question (or an array of them) (not a TOTP key, the `key` property of CConfirmation)
  * @param {int} time - The unix timestamp with which the following key was generated
- * @param {string} key - The confirmation key that was generated using the preceeding time and the tag "allow" (if accepting) or "cancel" (if not accepting)
+ * @param {string} key - The confirmation key that was generated using the preceding time and the tag "allow" (if accepting) or "cancel" (if not accepting)
  * @param {boolean} accept - true if you want to accept the confirmation, false if you want to cancel it
  * @param {SteamCommunity~genericErrorCallback} callback - Called when the request is complete
  */
@@ -146,6 +146,77 @@ SteamCommunity.prototype.respondToConfirmation = function(confID, confKey, time,
 	});
 };
 
+/**
+ * Accept a confirmation for a given object (trade offer or market listing) automatically.
+ * @param {string} identitySecret
+ * @param {number|string} objectID
+ * @param {SteamCommunity~genericErrorCallback} callback
+ */
+SteamCommunity.prototype.acceptConfirmationForObject = function(identitySecret, objectID, callback) {
+	var self = this;
+	this._usedConfTimes = this._usedConfTimes || [];
+
+	if (typeof this._timeOffset !== 'undefined') {
+		// time offset is already known and saved
+		doConfirmation();
+	} else {
+		SteamTotp.getTimeOffset(function(err, offset) {
+			if (err) {
+				callback(err);
+				return;
+			}
+
+			self._timeOffset = offset;
+			doConfirmation();
+
+			setTimeout(function() {
+				// Delete the saved time offset after 12 hours because why not
+				delete self._timeOffset;
+			}, 1000 * 60 * 60 * 12);
+		});
+	}
+
+	function doConfirmation() {
+		var offset = self._timeOffset;
+		var time = SteamTotp.time(offset);
+		self.getConfirmations(time, SteamTotp.getConfirmationKey(identitySecret, time, "conf"), function(err, confs) {
+			if (err) {
+				callback(err);
+				return;
+			}
+
+			var conf = confs.filter(function(conf) { return conf.creator == objectID; });
+			if (conf.length == 0) {
+				callback(new Error("Could not find confirmation for object " + objectID));
+				return;
+			}
+
+			conf = conf[0];
+
+			// make sure we don't reuse the same time
+			var localOffset = 0;
+			do {
+				time = SteamTotp.time(offset) + localOffset++;
+			} while (self._usedConfTimes.indexOf(time) != -1);
+
+			self._usedConfTimes.push(time);
+			if (self._usedConfTimes.length > 60) {
+				self._usedConfTimes.splice(0, self._usedConfTimes.length - 60); // we don't need to save more than 60 entries
+			}
+
+			conf.respond(time, SteamTotp.getConfirmationKey(identitySecret, time, "allow"), true, callback);
+		});
+	}
+};
+
+/**
+ * Send a single request to Steam to accept all outstanding confirmations (after loading the list). If one fails, the
+ * entire request will fail and there will be no way to know which failed without loading the list again.
+ * @param {number} time
+ * @param {string} confKey
+ * @param {string} allowKey
+ * @param {function} callback
+ */
 SteamCommunity.prototype.acceptAllConfirmations = function(time, confKey, allowKey, callback) {
 	var self = this;
 
@@ -258,8 +329,9 @@ SteamCommunity.prototype.checkConfirmations = function() {
 				// We should accept this
 				self.emit('debug', "Accepting confirmation #" + conf.id);
 				var time = Math.floor(Date.now() / 1000);
-				conf.respond(time, SteamTotp.getConfirmationKey(self._identitySecret, time, "allow"), true, function() {
+				conf.respond(time, SteamTotp.getConfirmationKey(self._identitySecret, time, "allow"), true, function(err) {
 					// If there was an error and it wasn't actually accepted, we'll pick it up again
+					if (!err) self.emit('confirmationAccepted', conf);
 					delete self._knownConfirmations[conf.id];
 					setTimeout(callback, 1000); // Call the callback in 1 second, to make sure the time changes
 				});
@@ -311,28 +383,6 @@ SteamCommunity.prototype.checkConfirmations = function() {
 			self._confirmationTimer = setTimeout(self.checkConfirmations.bind(self), self._confirmationPollInterval);
 		}
 	}
-
-	function handleNewConfirmation(conf, handleNumber) {
-		self._knownConfirmations[conf.id] = conf;
-
-		// Delay them by 1 second per new confirmation that we see, so that keys won't be the same.
-		setTimeout(function() {
-			if(self._identitySecret) {
-				self.emit('debug', 'Accepting confirmation #' + conf.id);
-				var time = Math.floor(Date.now() / 1000);
-				conf.respond(time, SteamTotp.getConfirmationKey(self._identitySecret, time, "allow"), true, function(err) {
-					if (err) {
-						self.emit('debug', "Can't accept confirmation #" + conf.id + ": " + err.message);
-					}
-
-					// We'll just retry next time we poll
-					delete self._knownConfirmations[conf.id];
-				});
-			} else {
-				self.emit('newConfirmation', conf);
-			}
-		}, handleNumber * 1000);
-	}
 };
 
 SteamCommunity.prototype._confirmationCheckerGetKey = function(tag, callback) {

components/http.js

@@ -47,10 +47,10 @@ SteamCommunity.prototype.httpRequest = function(uri, options, callback, source)
 
 		self.request(options, function (err, response, body) {
 			var hasCallback = !!callback;
-			var httpError = options.checkHttpError !== false && self._checkHttpError(err, response, 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 && !body ? new Error("Malformed JSON response") : null;
+			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,
@@ -85,29 +85,29 @@ SteamCommunity.prototype._notifySessionExpired = function(err) {
 	this.emit('sessionExpired', err);
 };
 
-SteamCommunity.prototype._checkHttpError = function(err, response, callback) {
+SteamCommunity.prototype._checkHttpError = function(err, response, callback, body) {
 	if (err) {
-		callback(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);
+		callback(err, response, body);
 		this._notifySessionExpired(err);
 		return err;
 	}
 
 	if (response.statusCode == 403 && response.body && 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);
+		callback(err, response, body);
 		return err;
 	}
 
 	if (response.statusCode >= 400) {
 		err = new Error("HTTP error " + response.statusCode);
 		err.code = response.statusCode;
-		callback(err);
+		callback(err, response, body);
 		return err;
 	}
 

components/inventoryhistory.js

@@ -49,7 +49,7 @@ SteamCommunity.prototype.getInventoryHistory = function(options, callback) {
 
 		var $ = Cheerio.load(body);
 		if (!$('.inventory_history_pagingrow').html()) {
-			callback("Malformed page: no paging row found");
+			callback(new Error("Malformed page: no paging row found"));
 			return;
 		}
 

components/users.js

@@ -257,10 +257,19 @@ SteamCommunity.prototype.getUserInventoryContexts = function(userID, callback) {
 	}, "steamcommunity");
 };
 
+/**
+ * Get the contents of a user's inventory context.
+ * @deprecated Use getUserInventoryContents instead
+ * @param {SteamID|string} userID - The user's SteamID as a SteamID object or a string which can parse into one
+ * @param {int} appID - The Steam application ID of the game for which you want an inventory
+ * @param {int} contextID - The ID of the "context" within the game you want to retrieve
+ * @param {boolean} tradableOnly - true to get only tradable items and currencies
+ * @param {function} callback
+ */
 SteamCommunity.prototype.getUserInventory = function(userID, appID, contextID, tradableOnly, callback) {
 	var self = this;
 
-	if(typeof userID === 'string') {
+	if (typeof userID === 'string') {
 		userID = new SteamID(userID);
 	}
 
@@ -270,6 +279,9 @@ SteamCommunity.prototype.getUserInventory = function(userID, appID, contextID, t
 	function get(inventory, currency, start) {
 		self.httpRequest({
 			"uri": "https://steamcommunity.com" + endpoint + "/inventory/json/" + appID + "/" + contextID,
+			"headers": {
+				"Referer": "https://steamcommunity.com" + endpoint + "/inventory"
+			},
 			"qs": {
 				"start": start,
 				"trading": tradableOnly ? 1 : undefined
@@ -281,34 +293,34 @@ SteamCommunity.prototype.getUserInventory = function(userID, appID, contextID, t
 				return;
 			}
 
-			if(!body || !body.success || !body.rgInventory || !body.rgDescriptions || !body.rgCurrency) {
-				if(body) {
+			if (!body || !body.success || !body.rgInventory || !body.rgDescriptions || !body.rgCurrency) {
+				if (body) {
 					callback(new Error(body.Error || "Malformed response"));
 				} else {
 					callback(new Error("Malformed response"));
 				}
-				
+
 				return;
 			}
 
 			var i;
-			for(i in body.rgInventory) {
-				if(!body.rgInventory.hasOwnProperty(i)) {
+			for (i in body.rgInventory) {
+				if (!body.rgInventory.hasOwnProperty(i)) {
 					continue;
 				}
 
 				inventory.push(new CEconItem(body.rgInventory[i], body.rgDescriptions, contextID));
 			}
 
-			for(i in body.rgCurrency) {
-				if(!body.rgCurrency.hasOwnProperty(i)) {
+			for (i in body.rgCurrency) {
+				if (!body.rgCurrency.hasOwnProperty(i)) {
 					continue;
 				}
 
 				currency.push(new CEconItem(body.rgInventory[i], body.rgDescriptions, contextID));
 			}
 
-			if(body.more) {
+			if (body.more) {
 				var match = response.request.uri.href.match(/\/(profiles|id)\/([^\/]+)\//);
 				if(match) {
 					endpoint = "/" + match[1] + "/" + match[2];
@@ -321,3 +333,118 @@ SteamCommunity.prototype.getUserInventory = function(userID, appID, contextID, t
 		}, "steamcommunity");
 	}
 };
+
+/**
+ * Get the contents of a user's inventory context.
+ * @param {SteamID|string} userID - The user's SteamID as a SteamID object or a string which can parse into one
+ * @param {int} appID - The Steam application ID of the game for which you want an inventory
+ * @param {int} contextID - The ID of the "context" within the game you want to retrieve
+ * @param {boolean} tradableOnly - true to get only tradable items and currencies
+ * @param {function} callback
+ */
+SteamCommunity.prototype.getUserInventoryContents = function(userID, appID, contextID, tradableOnly, callback) {
+	var self = this;
+
+	if(typeof userID === 'string') {
+		userID = new SteamID(userID);
+	}
+
+	var pos = 1;
+	get([], []);
+
+	function get(inventory, currency, start) {
+		self.httpRequest({
+			"uri": "https://steamcommunity.com/inventory/" + userID.getSteamID64() + "/" + appID + "/" + contextID,
+			"headers": {
+				"Referer": "https://steamcommunity.com/profiles/" + userID.getSteamID64() + "/inventory"
+			},
+			"qs": {
+				"l": "english", // Default language
+				"count": 5000, // Max items per 'page'
+				"start_assetid": start
+			},
+			"json": true
+		}, function(err, response, body) {
+			if (err) {
+				if (err.message == "HTTP error 403" && body === null) {
+					// 403 with a body of "null" means the inventory/profile is private.
+					if(userID.getSteamID64() == self.steamID.getSteamID64()) {
+						// We can never get private profile error for our own inventory!
+						self._notifySessionExpired(err);
+					}
+					
+					callback(new Error("This profile is private."));
+					return;
+				}
+
+				if (err.message == "HTTP error 500" && body && body.error) {
+					err = new Error(body.error);
+
+					var match = body.error.match(/^(.+) \((\d+)\)$/);
+					if (match) {
+						err.message = match[1];
+						err.eresult = match[2];
+						callback(err);
+						return;
+					}
+				}
+
+				callback(err);
+				return;
+			}
+
+			if (body && body.success && body.total_inventory_count === 0) {
+				// Empty inventory
+				callback(null, [], [], 0);
+				return;
+			}
+
+			if (!body || !body.success || !body.assets || !body.descriptions) {
+				if (body) {
+					// Dunno if the error/Error property even exists on this new endpoint
+					callback(new Error(body.error || body.Error || "Malformed response"));
+				} else {
+					callback(new Error("Malformed response"));
+				}
+				
+				return;
+			}
+
+			for (var i = 0; i < body.assets.length; i++) {
+				var description = getDescription(body.descriptions, body.assets[i].classid, body.assets[i].instanceid);
+				
+				if (!tradableOnly || (description && description.tradable)) {
+					body.assets[i].pos = pos++;
+					(body.assets[i].currencyid ? currency : inventory).push(new CEconItem(body.assets[i], description, contextID));
+				}
+			}
+
+			if (body.more_items) {
+				get(inventory, currency, body.last_assetid);
+			} else {
+				callback(null, inventory, currency, body.total_inventory_count);
+			}
+		}, "steamcommunity");
+	}
+
+	// A bit of optimization; objects are hash tables so it's more efficient to look up by key than to iterate an array
+	var quickDescriptionLookup = {};
+
+	function getDescription(descriptions, classID, instanceID) {
+		instanceID = instanceID || '0'; // instanceID can be undefined, in which case it's 0.
+
+		var key = classID + '_' + instanceID;
+
+		if (quickDescriptionLookup[key]) {
+			return quickDescriptionLookup[key];
+		}
+
+		for (var i = 0; i < descriptions.length; i++) {
+			quickDescriptionLookup[key] = descriptions[i];
+
+			if (descriptions[i].classid == classID && descriptions[i].instanceid == instanceID) {
+				return descriptions[i];
+			}
+		}
+	}
+};

components/webapi.js

@@ -3,7 +3,7 @@ var SteamCommunity = require('../index.js');
 SteamCommunity.prototype.getWebApiKey = function(domain, callback) {
 	var self = this;
 	this.httpRequest({
-		"uri": "https://steamcommunity.com/dev/apikey",
+		"uri": "https://steamcommunity.com/dev/apikey?l=english",
 		"followRedirect": false
 	}, function(err, response, body) {
 		if (err) {
@@ -21,7 +21,7 @@ SteamCommunity.prototype.getWebApiKey = function(domain, callback) {
 			callback(null, match[1]);
 		} else {
 			// We need to register a new API key
-			self.httpRequestPost('https://steamcommunity.com/dev/registerkey', {
+			self.httpRequestPost('https://steamcommunity.com/dev/registerkey?l=english', {
 				"form": {
 					"domain": domain,
 					"agreeToTerms": "agreed",

index.js

@@ -56,13 +56,20 @@ function SteamCommunity(options) {
 }
 
 SteamCommunity.prototype.login = function(details, callback) {
-	if(details.steamguard) {
+	if (!details.accountName || !details.password) {
+		throw new Error("Missing either accountName or password to login; both are needed");
+	}
+
+	if (details.steamguard) {
 		var parts = details.steamguard.split('||');
 		this._setCookie(Request.cookie('steamMachineAuth' + parts[0] + '=' + encodeURIComponent(parts[1])), true);
 	}
 	
 	var self = this;
 
+	// Delete the cache
+	delete self._profileURL;
+
 	// headers required to convince steam that we're logging in from a mobile device so that we can get the oAuth data
 	var mobileHeaders = {
 		"X-Requested-With": "com.valvesoftware.android.steam.community",
@@ -164,6 +171,8 @@ SteamCommunity.prototype.login = function(details, callback) {
 						break;
 					}
 				}
+
+				self.setCookies(cookies);
 				
 				callback(null, sessionID, cookies, steamguard, oAuth.oauth_token);
 			}
@@ -217,6 +226,7 @@ SteamCommunity.prototype.oAuthLogin = function(steamguard, token, callback) {
 
 SteamCommunity.prototype._setCookie = function(cookie, secure) {
 	var protocol = secure ? "https" : "http";
+	cookie.secure = !!secure;
 
 	this._jar.setCookie(cookie.clone(), protocol + "://steamcommunity.com");
 	this._jar.setCookie(cookie.clone(), protocol + "://store.steampowered.com");
@@ -311,8 +321,8 @@ SteamCommunity.prototype.getNotifications = function(callback) {
 			// dunno about 7
 			"gifts": body.notifications[8] || 0,
 			"chat": body.notifications[9] || 0,
-			"helpRequestReplies": body.notifications[10] || 0
-			// dunno about 11
+			"helpRequestReplies": body.notifications[10] || 0,
+			"accountAlerts": body.notifications[11] || 0
 		};
 
 		callback(null, notifications);

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "steamcommunity",
-	"version": "3.26.0",
+	"version": "3.30.4",
 	"description": "Provides an interface for logging into and interacting with the Steam Community website",
 	"keywords": ["steam", "steam community"],
 	"homepage": "https://github.com/DoctorMcKay/node-steamcommunity",
@@ -17,8 +17,8 @@
 		"node-bignumber": "^1.2.1",
 		"steamid": "^1.0.0",
 		"xml2js": "^0.4.11",
-		"cheerio": "0.19.0",
-		"async": "^1.4.2",
+		"cheerio": "0.22.0",
+		"async": "^2.1.4",
 		"steam-totp": "^1.3.0"
 	},
 	"engines": {