steamcommunity 3.41.8 → 3.44.0

package/examples/enable_twofactor.js

@@ -1,112 +1,112 @@
-// 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');
-
-const EResult = SteamCommunity.EResult;
-
-let community = new SteamCommunity();
-let rl = ReadLine.createInterface({
-	input: process.stdin,
-	output: process.stdout
-});
-
-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
-	}, (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: ',  (code) => {
-					doLogin(accountName, password, code);
-				});
-
-				return;
-			}
-
-			if (err.message == 'CAPTCHA') {
-				console.log(err.captchaurl);
-				rl.question('CAPTCHA: ', (captchaInput) => {
-					doLogin(accountName, password, authCode, captchaInput);
-				});
-
-				return;
-			}
-
-			console.log(err);
-			process.exit();
-			return;
-		}
-
-		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 == EResult.RateLimitExceeded) {
-					console.log('Error: RateLimitExceeded. Try again later.');
-					process.exit();
-					return;
-				}
-
-				console.log(err);
-				process.exit();
-				return;
-			}
-
-			if (response.status != EResult.OK) {
-				console.log(`Error: Status ${response.status}`);
-				process.exit();
-				return;
-			}
-
-			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);
-		});
-	});
-}
-
-function promptActivationCode(response) {
-	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;
-				}
-
-				console.log(err);
-			} else {
-				console.log('Two-factor authentication enabled!');
-			}
-
-			process.exit();
-		});
-	});
-}
+// 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');
+
+const EResult = SteamCommunity.EResult;
+
+let community = new SteamCommunity();
+let rl = ReadLine.createInterface({
+	input: process.stdin,
+	output: process.stdout
+});
+
+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
+	}, (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: ',  (code) => {
+					doLogin(accountName, password, code);
+				});
+
+				return;
+			}
+
+			if (err.message == 'CAPTCHA') {
+				console.log(err.captchaurl);
+				rl.question('CAPTCHA: ', (captchaInput) => {
+					doLogin(accountName, password, authCode, captchaInput);
+				});
+
+				return;
+			}
+
+			console.log(err);
+			process.exit();
+			return;
+		}
+
+		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 == EResult.RateLimitExceeded) {
+					console.log('Error: RateLimitExceeded. Try again later.');
+					process.exit();
+					return;
+				}
+
+				console.log(err);
+				process.exit();
+				return;
+			}
+
+			if (response.status != EResult.OK) {
+				console.log(`Error: Status ${response.status}`);
+				process.exit();
+				return;
+			}
+
+			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);
+		});
+	});
+}
+
+function promptActivationCode(response) {
+	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;
+				}
+
+				console.log(err);
+			} else {
+				console.log('Two-factor authentication enabled!');
+			}
+
+			process.exit();
+		});
+	});
+}

package/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') {
@@ -535,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');
@@ -545,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/package.json

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

package/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",
+};

package/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",
 };

package/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",
 };
+

package/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",
 };