3.44.0

Added getFriendsList

.idea/codeStyles/Project.xml

@@ -1,8 +1,5 @@
 <component name="ProjectCodeStyleConfiguration">
   <code_scheme name="Project" version="173">
-    <XML>
-      <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" />
-    </XML>
     <codeStyleSettings language="JSON">
       <indentOptions>
         <option name="USE_TAB_CHARACTER" value="true" />

.idea/codeStyles/codeStyleConfig.xml

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

.idea/modules.xml

@@ -2,6 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
+      <module fileurl="file://$PROJECT_DIR$/../node-steamcommunity Wiki/.idea/node-steamcommunity Wiki.iml" filepath="$PROJECT_DIR$/../node-steamcommunity Wiki/.idea/node-steamcommunity Wiki.iml" />
       <module fileurl="file://$PROJECT_DIR$/.idea/steamcommunity.iml" filepath="$PROJECT_DIR$/.idea/steamcommunity.iml" />
     </modules>
   </component>

.idea/steamcommunity.iml

@@ -5,5 +5,6 @@
     <content url="file://$MODULE_DIR$" />
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="module" module-name="node-steamcommunity Wiki" />
   </component>
 </module>

.idea/vcs.xml

@@ -2,5 +2,6 @@
 <project version="4">
   <component name="VcsDirectoryMappings">
     <mapping directory="" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/../node-steamcommunity Wiki" vcs="Git" />
   </component>
 </project>

classes/CEconItem.js

@@ -86,6 +86,8 @@ function CEconItem(item, description, contextID) {
 		this.actions = [];
 	}
 
+	// 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;
 	}

classes/CSteamUser.js

@@ -154,6 +154,14 @@ CSteamUser.prototype.comment = function(message, callback) {
 	this._community.postUserComment(this.steamID, message, callback);
 };
 
+CSteamUser.prototype.deleteComment = function(commentID, callback) {
+	this._community.deleteUserComment(this.steamID, commentID, callback);
+};
+
+CSteamUser.prototype.getComments = function(options, callback) {
+	this._community.getUserComments(this.steamID, options, callback);
+};
+
 CSteamUser.prototype.inviteToGroup = function(groupID, callback) {
 	this._community.inviteUserToGroup(this.steamID, groupID, callback);
 };
@@ -183,10 +191,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/help.js

@@ -0,0 +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);
+	};
+}

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
@@ -146,6 +148,124 @@ SteamCommunity.prototype.openBoosterPack = function(appid, assetid, callback) {
 	})
 };
 
+/**
+ * Get the booster pack catalog to see what booster packs you can create
+ * @param {function} callback
+ */
+SteamCommunity.prototype.getBoosterPackCatalog = function(callback) {
+	this.httpRequestGet('https://steamcommunity.com/tradingcards/boostercreator/', (err, res, body) => {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		let idx = body.indexOf('CBoosterCreatorPage.Init(');
+		if (idx == -1) {
+			callback(new Error('Malformed response'));
+			return;
+		}
+
+		let lines = body.slice(idx).split('\n').map(l => l.trim());
+
+		for (let i = 1; i <= 4; i++) {
+			if (typeof lines[i] != 'string' || !lines[i].match(/,$/)) {
+				let err = new Error('Malformed response');
+				err.line = i;
+				callback(err);
+				return;
+			}
+
+			lines[i] = lines[i].replace(/,$/, '');
+		}
+
+		let boosterPackCatalog, totalGems, tradableGems, untradableGems;
+		try {
+			boosterPackCatalog = JSON.parse(lines[1]);
+			totalGems = parseInt(lines[2].match(/\d+/)[0], 10);
+			tradableGems = parseInt(lines[3].match(/\d+/)[0], 10);
+			untradableGems = parseInt(lines[4].match(/\d+/)[0], 10);
+		} catch (ex) {
+			let err = new Error('Malformed response');
+			err.inner = ex;
+			callback(err);
+			return;
+		}
+
+		let keyedCatalog = {};
+		boosterPackCatalog.forEach((app) => {
+			app.price = parseInt(app.price, 10);
+			app.unavailable = app.unavailable || false;
+			app.availableAtTime = app.available_at_time || null;
+
+			if (typeof app.availableAtTime == 'string') {
+				app.availableAtTime = Helpers.decodeSteamTime(app.availableAtTime);
+			}
+
+			delete app.available_at_time;
+
+			keyedCatalog[app.appid] = app;
+		});
+
+		callback(null, {
+			totalGems,
+			tradableGems,
+			untradableGems,
+			catalog: keyedCatalog
+		});
+	});
+};
+
+/**
+ * Create a booster pack using gems.
+ * @param {int} appid
+ * @param {boolean} [useUntradableGems=false]
+ * @param callback
+ */
+SteamCommunity.prototype.createBoosterPack = function(appid, useUntradableGems, callback) {
+	if (typeof useUntradableGems == 'function') {
+		callback = useUntradableGems;
+		useUntradableGems = false;
+	}
+
+	this.httpRequestPost({
+		uri: 'https://steamcommunity.com/tradingcards/ajaxcreatebooster/',
+		form: {
+			sessionid: this.getSessionID(),
+			appid,
+			series: 1,
+			// tradability_preference can be a value 1-3
+			// 1: Prefer using tradable gems, but use untradable if necessary
+			// 2: Only use tradable gems
+			// 3: Prefer using untradable gems, but use tradable if necessary
+			tradability_preference: useUntradableGems ? 3 : 2
+		},
+		json: true,
+		checkHttpError: false
+	}, (err, res, body) => {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if (body.purchase_eresult && body.purchase_eresult != 1) {
+			callback(Helpers.eresultError(body.purchase_eresult));
+			return;
+		}
+
+		// We can now check HTTP status codes
+		if (this._checkHttpError(err, res, callback, body)) {
+			return;
+		}
+
+		callback(null, {
+			totalGems: parseInt(body.goo_amount, 10),
+			tradableGems: parseInt(body.tradable_goo_amount, 10),
+			untradableGems: parseInt(body.untradable_goo_amount, 10),
+			resultItem: body.purchase_result
+		});
+	});
+};
+
 /**
  * Get details about a gift in your inventory.
  * @param {string} giftID
@@ -203,6 +323,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);
@@ -212,3 +333,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/users.js

@@ -136,7 +136,7 @@ SteamCommunity.prototype.postUserComment = function(userID, message, callback) {
 		"uri": "https://steamcommunity.com/comment/Profile/post/" + userID.toString() + "/-1",
 		"form": {
 			"comment": message,
-			"count": 6,
+			"count": 1,
 			"sessionid": this.getSessionID()
 		},
 		"json": true
@@ -151,9 +151,109 @@ SteamCommunity.prototype.postUserComment = function(userID, message, callback) {
 		}
 
 		if(body.success) {
+			const $ = Cheerio.load(body.comments_html);
+			const commentID = $('.commentthread_comment').attr('id').split('_')[1];
+
+			callback(null, commentID);
+		} else if(body.error) {
+			callback(new Error(body.error));
+		} else {
+			callback(new Error("Unknown error"));
+		}
+	}, "steamcommunity");
+};
+
+SteamCommunity.prototype.deleteUserComment = function(userID, commentID, callback) {
+	if(typeof userID === 'string') {
+		userID = new SteamID(userID);
+	}
+
+	var self = this;
+	this.httpRequestPost({
+		"uri": "https://steamcommunity.com/comment/Profile/delete/" + userID.toString() + "/-1",
+		"form": {
+			"gidcomment": commentID,
+			"start": 0,
+			"count": 1,
+			"sessionid": this.getSessionID(),
+			"feature2": -1
+		},
+		"json": true
+	}, function(err, response, body) {
+		if(!callback) {
+			return;
+		}
+
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if(body.success && !body.comments_html.includes(commentID)) {
 			callback(null);
 		} else if(body.error) {
 			callback(new Error(body.error));
+		} else if(body.comments_html.includes(commentID)) {
+			callback(new Error("Failed to delete comment"));
+		} else {
+			callback(new Error("Unknown error"));
+		}
+	}, "steamcommunity");
+};
+
+SteamCommunity.prototype.getUserComments = function(userID, options, callback) {
+	if(typeof userID === 'string') {
+		userID = new SteamID(userID);
+	}
+
+	if (typeof options === 'function') {
+		callback = options;
+		options = {};
+	}
+
+	var form = Object.assign({
+		"start": 0,
+		"count": 0,
+		"feature2": -1,
+		"sessionid": this.getSessionID()
+	}, options);
+
+	this.httpRequestPost({
+		"uri": "https://steamcommunity.com/comment/Profile/render/" + userID.toString() + "/-1",
+		"form": form,
+		"json": true
+	}, function(err, response, body) {
+		if(!callback) {
+			return;
+		}
+
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if(body.success) {
+			const $ = Cheerio.load(body.comments_html);
+			const comments = $(".commentthread_comment.responsive_body_text[id]").map((i, elem) => {
+				var $elem = $(elem),
+					$commentContent = $elem.find(".commentthread_comment_text");
+				return {
+					id: $elem.attr("id").split("_")[1],
+					author: {
+						steamID: new SteamID("[U:1:" + $elem.find("[data-miniprofile]").data("miniprofile") + "]"),
+						name: $elem.find("bdi").text(),
+						avatar: $elem.find(".playerAvatar img[src]").attr("src"),
+						state: $elem.find(".playerAvatar").attr("class").split(" ").pop()
+					},
+					date: new Date($elem.find(".commentthread_comment_timestamp").data("timestamp") * 1000),
+					text: $commentContent.text().trim(),
+					html: $commentContent.html().trim()
+				}
+			}).get();
+
+			callback(null, comments, body.total_count);
+		} else if(body.error) {
+			callback(new Error(body.error));
 		} else {
 			callback(new Error("Unknown error"));
 		}

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.'));
 };

index.js

@@ -14,6 +14,7 @@ module.exports = SteamCommunity;
 SteamCommunity.SteamID = SteamID;
 SteamCommunity.ConfirmationType = require('./resources/EConfirmationType.js');
 SteamCommunity.EResult = require('./resources/EResult.js');
+SteamCommunity.EFriendRelationship = require('./resources/EFriendRelationship.js');
 
 
 function SteamCommunity(options) {
@@ -303,8 +304,8 @@ SteamCommunity.prototype.setCookies = function(cookies) {
 	});
 };
 
-SteamCommunity.prototype.getSessionID = function() {
-	var cookies = this._jar.getCookieString("http://steamcommunity.com").split(';');
+SteamCommunity.prototype.getSessionID = function(host = "http://steamcommunity.com") {
+	var cookies = this._jar.getCookieString(host).split(';');
 	for(var i = 0; i < cookies.length; i++) {
 		var match = cookies[i].trim().match(/([^=]+)=(.+)/);
 		if(match[1] == 'sessionid') {
@@ -323,11 +324,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) {
@@ -533,6 +536,37 @@ SteamCommunity.prototype._myProfile = function(endpoint, form, callback) {
 	}
 };
 
+/**
+ * Returns an object whose keys are 64-bit SteamIDs, and whose values are values from the EFriendRelationship enum.
+ * Therefore, you can deduce your friends or blocked list from this object.
+ * @param {function} callback
+ */
+SteamCommunity.prototype.getFriendsList = function(callback) {
+	this.httpRequestGet({
+		"uri": "https://steamcommunity.com/textfilter/ajaxgetfriendslist",
+		"json": true
+	}, (err, res, body) => {
+		if (err) {
+			callback(err ? err : new Error('HTTP error ' + res.statusCode));
+			return;
+		}
+
+		if (body.success != 1) {
+			callback(Helpers.eresultError(body.success));
+			return;
+		}
+
+		if (!body.friendslist || !body.friendslist.friends) {
+			callback(new Error('Malformed response'));
+			return;
+		}
+
+		const friends = {};
+		body.friendslist.friends.forEach(friend => (friends[friend.ulfriendid] = friend.efriendrelationship));
+		callback(null, friends);
+	});
+};
+
 require('./components/http.js');
 require('./components/chat.js');
 require('./components/profile.js');
@@ -543,6 +577,7 @@ require('./components/inventoryhistory.js');
 require('./components/webapi.js');
 require('./components/twofactor.js');
 require('./components/confirmations.js');
+require('./components/help.js');
 require('./classes/CMarketItem.js');
 require('./classes/CMarketSearchResult.js');
 require('./classes/CSteamGroup.js');

package.json

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

resources/EFriendRelationship.js

@@ -0,0 +1,23 @@
+/**
+ * @enum EFriendRelationship
+ */
+ module.exports = {
+	"None": 0,
+	"Blocked": 1,
+	"RequestRecipient": 2,
+	"Friend": 3,
+	"RequestInitiator": 4,
+	"Ignored": 5,
+	"IgnoredFriend": 6,
+	"SuggestedFriend": 7, // removed "was used by the original implementation of the facebook linking feature; but now unused."
+
+	// Value-to-name mapping for convenience
+	"0": "None",
+	"1": "Blocked",
+	"2": "RequestRecipient",
+	"3": "Friend",
+	"4": "RequestInitiator",
+	"5": "Ignored",
+	"6": "IgnoredFriend",
+	"7": "SuggestedFriend",
+};

resources/EPersonaState.js

@@ -9,7 +9,7 @@ module.exports = {
 	"Snooze": 4,
 	"LookingToTrade": 5,
 	"LookingToPlay": 6,
-	"Max": 7,
+	"Invisible": 7,
 
 	// Value-to-name mapping for convenience
 	"0": "Offline",
@@ -19,5 +19,5 @@ module.exports = {
 	"4": "Snooze",
 	"5": "LookingToTrade",
 	"6": "LookingToPlay",
-	"7": "Max",
+	"7": "Invisible",
 };

resources/EPersonaStateFlag.js

@@ -4,7 +4,8 @@
 module.exports = {
 	"HasRichPresence": 1,
 	"InJoinableGame": 2,
-	"Golden": 4, // removed "no longer has any effect"
+	"Golden": 4,
+	"RemotePlayTogether": 8,
 	"OnlineUsingWeb": 256, // removed "renamed to ClientTypeWeb"
 	"ClientTypeWeb": 256,
 	"OnlineUsingMobile": 512, // removed "renamed to ClientTypeMobile"
@@ -14,14 +15,18 @@ module.exports = {
 	"OnlineUsingVR": 2048, // removed "renamed to ClientTypeVR"
 	"ClientTypeVR": 2048,
 	"LaunchTypeGamepad": 4096,
+	"LaunchTypeCompatTool": 8192,
 
 	// Value-to-name mapping for convenience
 	"1": "HasRichPresence",
 	"2": "InJoinableGame",
 	"4": "Golden",
+	"8": "RemotePlayTogether",
 	"256": "ClientTypeWeb",
 	"512": "ClientTypeMobile",
 	"1024": "ClientTypeTenfoot",
 	"2048": "ClientTypeVR",
 	"4096": "LaunchTypeGamepad",
+	"8192": "LaunchTypeCompatTool",
 };
+

resources/EResult.js

@@ -123,6 +123,13 @@ module.exports = {
 	"WGNetworkSendExceeded": 110,
 	"AccountNotFriends": 111,
 	"LimitedUserAccount": 112,
+	"CantRemoveItem": 113,
+	"AccountHasBeenDeleted": 114,
+	"AccountHasAnExistingUserCancelledLicense": 115,
+	"DeniedDueToCommunityCooldown": 116,
+	"NoLauncherSpecified": 117,
+	"MustAgreeToSSA": 118,
+	"ClientNoLongerSupported": 119,
 
 	// Value-to-name mapping for convenience
 	"0": "Invalid",
@@ -237,4 +244,11 @@ module.exports = {
 	"110": "WGNetworkSendExceeded",
 	"111": "AccountNotFriends",
 	"112": "LimitedUserAccount",
+	"113": "CantRemoveItem",
+	"114": "AccountHasBeenDeleted",
+	"115": "AccountHasAnExistingUserCancelledLicense",
+	"116": "DeniedDueToCommunityCooldown",
+	"117": "NoLauncherSpecified",
+	"118": "MustAgreeToSSA",
+	"119": "ClientNoLongerSupported",
 };