3.42.0

Added Sack of Gems <---> Gems transformations

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: DoctorMcKay
+custom: 'https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=N36YVAT42CZ4G&item_name=node%2dsteamcommunity&currency_code=USD'

.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +1,5 @@
 <component name="ProjectCodeStyleConfiguration">
   <state>
-    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default (1)" />
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
   </state>
 </component>

classes/CEconItem.js

@@ -86,7 +86,11 @@ function CEconItem(item, description, contextID) {
 		this.actions = [];
 	}
 
-	 delete this.currency;
+	// One wouldn't think that we need this if statement, but apparently v8 has a weird bug/quirk where deleting a
+	// property results in greatly increased memory usage. Because that makes sense.
+	if (this.currency) {
+		delete this.currency;
+	}
 }
 
 CEconItem.prototype.getImageURL = function() {

classes/CSteamGroup.js

@@ -78,8 +78,8 @@ CSteamGroup.prototype.getAllAnnouncements = function(time, callback) {
 	this._community.getAllGroupAnnouncements(this.steamID, time, callback);
 };
 
-CSteamGroup.prototype.postAnnouncement = function(headline, content, callback) {
-	this._community.postGroupAnnouncement(this.steamID, headline, content, callback);
+CSteamGroup.prototype.postAnnouncement = function(headline, content, hidden, callback) {
+	this._community.postGroupAnnouncement(this.steamID, headline, content, hidden, callback);
 };
 
 CSteamGroup.prototype.editAnnouncement = function(annoucementID, headline, content, callback) {

classes/CSteamUser.js

@@ -183,10 +183,11 @@ CSteamUser.prototype.getInventory = function(appID, contextID, tradableOnly, cal
  * @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 {string} [language] - The language of item descriptions to return. Omit for default (which may either be English or your account's chosen language)
  * @param callback
  */
-CSteamUser.prototype.getInventoryContents = function(appID, contextID, tradableOnly, callback) {
-	this._community.getUserInventoryContents(this.steamID, appID, contextID, tradableOnly, callback);
+CSteamUser.prototype.getInventoryContents = function(appID, contextID, tradableOnly, language, callback) {
+	this._community.getUserInventoryContents(this.steamID, appID, contextID, tradableOnly, language, callback);
 };
 
 /**

components/confirmations.js

@@ -172,7 +172,7 @@ SteamCommunity.prototype.acceptConfirmationForObject = function(identitySecret,
 			setTimeout(function() {
 				// Delete the saved time offset after 12 hours because why not
 				delete self._timeOffset;
-			}, 1000 * 60 * 60 * 12);
+			}, 1000 * 60 * 60 * 12).unref();
 		});
 	}
 

components/market.js

@@ -1,5 +1,7 @@
-var SteamCommunity = require('../index.js');
-var Cheerio = require('cheerio');
+const SteamCommunity = require('../index.js');
+const Cheerio = require('cheerio');
+
+const Helpers = require('./helpers.js');
 
 /**
  * Get a list of all apps on the market
@@ -109,6 +111,43 @@ SteamCommunity.prototype.turnItemIntoGems = function(appid, assetid, expectedGem
 	})
 };
 
+/**
+ * Open a booster pack.
+ * @param {int} appid
+ * @param {int|string} assetid
+ * @param {function} callback
+ */
+SteamCommunity.prototype.openBoosterPack = function(appid, assetid, callback) {
+	this._myProfile({
+		"endpoint": "ajaxunpackbooster/",
+		"json": true,
+		"checkHttpError": false
+	}, {
+		"appid": appid,
+		"communityitemid": assetid,
+		"sessionid": this.getSessionID()
+	}, (err, res, body) => {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if (body.success && body.success != SteamCommunity.EResult.OK) {
+			let err = new Error(body.message || SteamCommunity.EResult[body.success]);
+			err.eresult = err.code = body.success;
+			callback(err);
+			return;
+		}
+
+		if (!body.rgItems) {
+			callback(new Error("Malformed response"));
+			return;
+		}
+
+		callback(null, body.rgItems);
+	})
+};
+
 /**
  * Get details about a gift in your inventory.
  * @param {string} giftID
@@ -166,6 +205,7 @@ SteamCommunity.prototype.redeemGift = function(giftID, callback) {
 		}
 
 		if (body.success && body.success != SteamCommunity.EResult.OK) {
+
 			let err = new Error(body.message || SteamCommunity.EResult[body.success]);
 			err.eresult = err.code = body.success;
 			callback(err);
@@ -175,3 +215,55 @@ SteamCommunity.prototype.redeemGift = function(giftID, callback) {
 		callback(null);
 	});
 };
+
+/**
+ * @param {int|string} assetid
+ * @param {int} denominationIn
+ * @param {int} denominationOut
+ * @param {int} quantityIn
+ * @param {int} quantityOut
+ * @param {function} callback
+ * @private
+ */
+SteamCommunity.prototype._gemExchange = function(assetid, denominationIn, denominationOut, quantityIn, quantityOut, callback) {
+	this._myProfile({
+		endpoint: 'ajaxexchangegoo/',
+		json: true,
+		checkHttpError: false
+	}, {
+		appid: 753,
+		assetid,
+		goo_denomination_in: denominationIn,
+		goo_amount_in: quantityIn,
+		goo_denomination_out: denominationOut,
+		goo_amount_out_expected: quantityOut,
+		sessionid: this.getSessionID()
+	}, (err, res, body) => {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		callback(Helpers.eresultError(body.success));
+	});
+};
+
+/**
+ * Pack gems into sack of gems.
+ * @param {int|string} assetid - ID of gem stack you want to pack into sacks
+ * @param {int} desiredSackCount - How many sacks you want. You must have at least this amount * 1000 gems in the stack you're packing
+ * @param {function} callback
+ */
+SteamCommunity.prototype.packGemSacks = function(assetid, desiredSackCount, callback) {
+	this._gemExchange(assetid, 1, 1000, desiredSackCount * 1000, desiredSackCount, callback);
+};
+
+/**
+ * Unpack sack of gems into gems.
+ * @param {int|string} assetid - ID of sack stack you want to unpack (say that 5 times fast)
+ * @param {int} sacksToUnpack
+ * @param {function} callback
+ */
+SteamCommunity.prototype.unpackGemSacks = function(assetid, sacksToUnpack, callback) {
+	this._gemExchange(assetid, 1000, 1, sacksToUnpack, sacksToUnpack * 1000, callback);
+};

components/profile.js

@@ -34,31 +34,45 @@ SteamCommunity.prototype.setupProfile = function(callback) {
 
 SteamCommunity.prototype.editProfile = function(settings, callback) {
 	var self = this;
-	this._myProfile("edit", null, function(err, response, body) {
-		if(err || response.statusCode != 200) {
-			if(callback) {
-				callback(err || new Error("HTTP error " + response.statusCode));
+	this._myProfile('edit/info', null, function(err, response, body) {
+		if (err || response.statusCode != 200) {
+			if (callback) {
+				callback(err || new Error('HTTP error ' + response.statusCode));
 			}
 
 			return;
 		}
 
 		var $ = Cheerio.load(body);
-		var form = $('#editForm');
-		if(!form) {
-			if(callback) {
-				callback(new Error("Malformed response"));
+		var existingSettings = $('#profile_edit_config').data('profile-edit');
+		if (!existingSettings || !existingSettings.strPersonaName) {
+			if (callback) {
+				callback(new Error('Malformed response'));
 			}
 
 			return;
 		}
 
-		var values = {};
-		form.serializeArray().forEach(function(item) {
-			values[item.name] = item.value;
-		});
+		var values = {
+			sessionID: self.getSessionID(),
+			type: 'profileSave',
+			weblink_1_title: '',
+			weblink_1_url: '',
+			weblink_2_title: '',
+			weblink_2_url: '',
+			weblink_3_title: '',
+			weblink_3_url: '',
+			personaName: existingSettings.strPersonaName,
+			real_name: existingSettings.strRealName,
+			summary: existingSettings.strSummary,
+			country: existingSettings.LocationData.locCountryCode,
+			state: existingSettings.LocationData.locStateCode,
+			city: existingSettings.LocationData.locCityCode,
+			customURL: existingSettings.strCustomURL,
+			json: 1
+		};
 
-		for(var i in settings) {
+		for (var i in settings) {
 			if(!settings.hasOwnProperty(i)) {
 				continue;
 			}
@@ -92,6 +106,8 @@ SteamCommunity.prototype.editProfile = function(settings, callback) {
 					values.customURL = settings[i];
 					break;
 
+				// These don't work right now
+				/*
 				case 'background':
 					// The assetid of our desired profile background
 					values.profile_background = settings[i];
@@ -110,60 +126,55 @@ SteamCommunity.prototype.editProfile = function(settings, callback) {
 					}
 
 					break;
-
+				*/
 				// TODO: profile showcases
 			}
 		}
 
-		self._myProfile("edit", values, function(err, response, body) {
+		self._myProfile('edit', values, function(err, response, body) {
 			if (settings.customURL) {
 				delete self._profileURL;
 			}
 
-			if(err || response.statusCode != 200) {
-				if(callback) {
-					callback(err || new Error("HTTP error " + response.statusCode));
-				}
-
+			if (!callback) {
 				return;
 			}
 
-			// Check for an error
-			var $ = Cheerio.load(body);
-			var error = $('#errorText .formRowFields');
-			if(error) {
-				error = error.text().trim();
-				if(error) {
-					if(callback) {
-						callback(new Error(error));
-					}
-
-					return;
-				}
+			if (err || response.statusCode != 200) {
+				callback(err || new Error('HTTP error ' + response.statusCode));
+				return;
 			}
 
-			if(callback) {
+			try {
+				var json = JSON.parse(body);
+				if (!json.success || json.success != 1) {
+					callback(new Error(json.errmsg || 'Request was not successful'));
+					return;
+				}
+
 				callback(null);
+			} catch (ex) {
+				callback(ex);
 			}
 		});
 	});
 };
 
 SteamCommunity.prototype.profileSettings = function(settings, callback) {
-	this._myProfile("edit/settings", null, (err, response, body) => {
+	this._myProfile('edit/settings', null, (err, response, body) => {
 		if (err || response.statusCode != 200) {
 			if (callback) {
-				callback(err || new Error("HTTP error " + response.statusCode));
+				callback(err || new Error('HTTP error ' + response.statusCode));
 			}
 
 			return;
 		}
 
 		var $ = Cheerio.load(body);
-		var existingSettings = $('.ProfileReactRoot[data-privacysettings]').data('privacysettings');
-		if (!existingSettings) {
-			if(callback) {
-				callback(new Error("Malformed response"));
+		var existingSettings = $('#profile_edit_config').data('profile-edit');
+		if (!existingSettings || !existingSettings.Privacy) {
+			if (callback) {
+				callback(new Error('Malformed response'));
 			}
 
 			return;
@@ -171,8 +182,8 @@ SteamCommunity.prototype.profileSettings = function(settings, callback) {
 
 		// PrivacySettings => {PrivacyProfile, PrivacyInventory, PrivacyInventoryGifts, PrivacyOwnedGames, PrivacyPlaytime}
 		// eCommentPermission
-		var privacy = existingSettings.PrivacySettings;
-		var commentPermission = existingSettings.eCommentPermission;
+		var privacy = existingSettings.Privacy.PrivacySettings;
+		var commentPermission = existingSettings.Privacy.eCommentPermission;
 
 		for (var i in settings) {
 			if (!settings.hasOwnProperty(i)) {
@@ -211,18 +222,18 @@ SteamCommunity.prototype.profileSettings = function(settings, callback) {
 		}
 
 		this._myProfile({
-			"method": "POST",
-			"endpoint": "ajaxsetprivacy/",
-			"json": true,
-			"formData": { // it's multipart because lolvalve
-				"sessionid": this.getSessionID(),
-				"Privacy": JSON.stringify(privacy),
-				"eCommentPermission": commentPermission
+			method: 'POST',
+			endpoint: 'ajaxsetprivacy/',
+			json: true,
+			formData: { // it's multipart because lolvalve
+				sessionid: this.getSessionID(),
+				Privacy: JSON.stringify(privacy),
+				eCommentPermission: commentPermission
 			}
 		}, null, function(err, response, body) {
 			if (err || response.statusCode != 200) {
 				if (callback) {
-					callback(err || new Error("HTTP error " + response.statusCode));
+					callback(err || new Error('HTTP error ' + response.statusCode));
 				}
 
 				return;
@@ -230,7 +241,7 @@ SteamCommunity.prototype.profileSettings = function(settings, callback) {
 
 			if (body.success != 1) {
 				if (callback) {
-					callback(new Error(body.success ? "Error " + body.success : "Request was not successful"));
+					callback(new Error(body.success ? 'Error ' + body.success : 'Request was not successful'));
 				}
 
 				return;

components/webapi.js

@@ -49,25 +49,9 @@ SteamCommunity.prototype.getWebApiKey = function(domain, callback) {
  * @param {function} callback
  */
 SteamCommunity.prototype.getWebApiOauthToken = function(callback) {
-	var self = this;
-
-	if( this.oAuthToken ) {
-		return callback( null, this.oAuthToken );
+	if (this.oAuthToken) {
+		return callback(null, this.oAuthToken);
 	}
 
-	// Pull an oauth token from the webchat UI
-	this.httpRequest("https://steamcommunity.com/chat", function(err, response, body) {
-		if (err) {
-			callback(err);
-			return;
-		}
-
-		var match = body.match(/"([0-9a-f]{32})"/);
-		if (!match) {
-			callback(new Error("Malformed response"));
-			return;
-		}
-
-		callback(null, match[1]);
-	}, "steamcommunity");
+	callback(new Error('This operation requires an OAuth token, which can only be obtained from node-steamcommunity\'s `login` method.'));
 };

examples/disable_twofactor.js

@@ -1,18 +1,19 @@
-var SteamCommunity = require('../index.js');
-var ReadLine = require('readline');
-var fs = require('fs');
+// If you aren't running this script inside of the repository, replace the following line with:
+// const SteamCommunity = require('steamcommunity');
+const SteamCommunity = require('../index.js');
+const ReadLine = require('readline');
 
-var community = new SteamCommunity();
-var rl = ReadLine.createInterface({
-	"input": process.stdin,
-	"output": process.stdout
+let community = new SteamCommunity();
+let rl = ReadLine.createInterface({
+	input: process.stdin,
+	output: process.stdout
 });
 
-rl.question("Username: ", function(accountName) {
-	rl.question("Password: ", function(password) {
-		rl.question("Two-Factor Auth Code: ", function(authCode) {
-			rl.question("Revocation Code: R", function(rCode) {
-				doLogin(accountName, password, authCode, "", rCode);
+rl.question('Username: ', (accountName) => {
+	rl.question('Password: ', (password) => {
+		rl.question('Two-Factor Auth Code: ', (authCode) =>{
+			rl.question('Revocation Code: R', (rCode) => {
+				doLogin(accountName, password, authCode, '', rCode);
 			});
 		});
 	});
@@ -20,21 +21,21 @@ rl.question("Username: ", function(accountName) {
 
 function doLogin(accountName, password, authCode, captcha, rCode) {
 	community.login({
-		"accountName": accountName,
-		"password": password,
-		"twoFactorCode": authCode,
-		"captcha": captcha
-	}, function(err, sessionID, cookies, steamguard) {
-		if(err) {
-			if(err.message == 'SteamGuard') {
-				console.log("This account does not have two-factor authentication enabled.");
+		accountName: accountName,
+		password: password,
+		twoFactorCode: authCode,
+		captcha: captcha
+	}, (err, sessionID, cookies, steamguard) => {
+		if (err) {
+			if (err.message == 'SteamGuard') {
+				console.log('This account does not have two-factor authentication enabled.');
 				process.exit();
 				return;
 			}
 
-			if(err.message == 'CAPTCHA') {
+			if (err.message == 'CAPTCHA') {
 				console.log(err.captchaurl);
-				rl.question("CAPTCHA: ", function(captchaInput) {
+				rl.question('CAPTCHA: ', (captchaInput) => {
 					doLogin(accountName, password, authCode, captchaInput);
 				});
 
@@ -46,15 +47,15 @@ function doLogin(accountName, password, authCode, captcha, rCode) {
 			return;
 		}
 
-		console.log("Logged on!");
-		community.disableTwoFactor("R" + rCode, function(err) {
-			if(err) {
+		console.log('Logged on!');
+		community.disableTwoFactor('R' + rCode, (err) => {
+			if (err) {
 				console.log(err);
 				process.exit();
 				return;
 			}
 
-			console.log("Two-factor authentication disabled!");
+			console.log('Two-factor authentication disabled!');
 			process.exit();
 		});
 	});

examples/enable_twofactor.js

@@ -1,45 +1,49 @@
-var SteamCommunity = require('../index.js');
-var ReadLine = require('readline');
-var fs = require('fs');
+// If you aren't running this script inside of the repository, replace the following line with:
+// const SteamCommunity = require('steamcommunity');
+const SteamCommunity = require('../index.js');
+const ReadLine = require('readline');
+const FS = require('fs');
 
-var community = new SteamCommunity();
-var rl = ReadLine.createInterface({
-	"input": process.stdin,
-	"output": process.stdout
+const EResult = SteamCommunity.EResult;
+
+let community = new SteamCommunity();
+let rl = ReadLine.createInterface({
+	input: process.stdin,
+	output: process.stdout
 });
 
-rl.question("Username: ", function(accountName) {
-	rl.question("Password: ", function(password) {
+rl.question('Username: ', (accountName) => {
+	rl.question('Password: ', (password) => {
 		doLogin(accountName, password);
 	});
 });
 
 function doLogin(accountName, password, authCode, captcha) {
 	community.login({
-		"accountName": accountName,
-		"password": password,
-		"authCode": authCode,
-		"captcha": captcha
-	}, function(err, sessionID, cookies, steamguard) {
-		if(err) {
-			if(err.message == 'SteamGuardMobile') {
-				console.log("This account already has two-factor authentication enabled.");
+		accountName: accountName,
+		password: password,
+		authCode: authCode,
+		captcha: captcha
+	}, (err, sessionID, cookies, steamguard) => {
+		if (err) {
+			if (err.message == 'SteamGuardMobile') {
+				console.log('This account already has two-factor authentication enabled.');
 				process.exit();
 				return;
 			}
 
-			if(err.message == 'SteamGuard') {
-				console.log("An email has been sent to your address at " + err.emaildomain);
-				rl.question("Steam Guard Code: ", function (code) {
+			if (err.message == 'SteamGuard') {
+				console.log(`An email has been sent to your address at ${err.emaildomain}`);
+				rl.question('Steam Guard Code: ',  (code) => {
 					doLogin(accountName, password, code);
 				});
 
 				return;
 			}
 
-			if(err.message == 'CAPTCHA') {
+			if (err.message == 'CAPTCHA') {
 				console.log(err.captchaurl);
-				rl.question("CAPTCHA: ", function(captchaInput) {
+				rl.question('CAPTCHA: ', (captchaInput) => {
 					doLogin(accountName, password, authCode, captchaInput);
 				});
 
@@ -51,17 +55,17 @@ function doLogin(accountName, password, authCode, captcha) {
 			return;
 		}
 
-		console.log("Logged on!");
-		community.enableTwoFactor(function(err, response) {
-			if(err) {
-				if(err.eresult == 2) {
-					console.log("Error: Failed to enable two-factor authentication. Do you have a phone number attached to your account?");
+		console.log('Logged on!');
+		community.enableTwoFactor((err, response) => {
+			if (err) {
+				if (err.eresult == EResult.Fail) {
+					console.log('Error: Failed to enable two-factor authentication. Do you have a phone number attached to your account?');
 					process.exit();
 					return;
 				}
 
-				if(err.eresult == 84) {
-					console.log("Error: RateLimitExceeded. Try again later.");
+				if (err.eresult == EResult.RateLimitExceeded) {
+					console.log('Error: RateLimitExceeded. Try again later.');
 					process.exit();
 					return;
 				}
@@ -71,15 +75,16 @@ function doLogin(accountName, password, authCode, captcha) {
 				return;
 			}
 
-			if(response.status != 1) {
-				console.log("Error: Status " + response.status);
+			if (response.status != EResult.OK) {
+				console.log(`Error: Status ${response.status}`);
 				process.exit();
 				return;
 			}
 
-			console.log("Writing secrets to twofactor_" + community.steamID.getSteamID64() + ".json");
-			console.log("Revocation code: " + response.revocation_code);
-			fs.writeFileSync("twofactor_" + community.steamID.getSteamID64() + ".json", JSON.stringify(response, null, "\t"));
+			let filename = `twofactor_${community.steamID.getSteamID64()}.json`;
+			console.log(`Writing secrets to ${filename}`);
+			console.log(`Revocation code: ${response.revocation_code}`);
+			FS.writeFileSync(filename, JSON.stringify(response, null, '\t'));
 
 			promptActivationCode(response);
 		});
@@ -87,10 +92,10 @@ function doLogin(accountName, password, authCode, captcha) {
 }
 
 function promptActivationCode(response) {
-	rl.question("SMS Code: ", function(smsCode) {
-		community.finalizeTwoFactor(response.shared_secret, smsCode, function(err) {
-			if(err) {
-				if(err.message == "Invalid activation code") {
+	rl.question('SMS Code: ', (smsCode) => {
+		community.finalizeTwoFactor(response.shared_secret, smsCode, (err) => {
+			if (err) {
+				if (err.message == 'Invalid activation code') {
 					console.log(err);
 					promptActivationCode(response);
 					return;
@@ -98,7 +103,7 @@ function promptActivationCode(response) {
 
 				console.log(err);
 			} else {
-				console.log("Two-factor authentication enabled!");
+				console.log('Two-factor authentication enabled!');
 			}
 
 			process.exit();

index.js

@@ -323,11 +323,13 @@ function generateSessionID() {
 
 SteamCommunity.prototype.parentalUnlock = function(pin, callback) {
 	var self = this;
+	var sessionID = self.getSessionID();
 
 	this.httpRequestPost("https://steamcommunity.com/parental/ajaxunlock", {
 		"json": true,
 		"form": {
-			"pin": pin
+			"pin": pin,
+			"sessionid": sessionID
 		}
 	}, function(err, response, body) {
 		if(!callback) {

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "steamcommunity",
-	"version": "3.41.2",
+	"version": "3.42.0",
 	"description": "Provides an interface for logging into and interacting with the Steam Community website",
 	"keywords": [
 		"steam",