steamcommunity 3.46.1 → 3.47.0

package/components/webapi.js

@@ -1,118 +1,118 @@
-var SteamCommunity = require('../index.js');
-
-const Helpers = require('./helpers.js');
-
-SteamCommunity.prototype.getWebApiKey = function(domain, callback) {
-	var self = this;
-	this.httpRequest({
-		"uri": "https://steamcommunity.com/dev/apikey?l=english",
-		"followRedirect": false
-	}, function(err, response, body) {
-		if (err) {
-			callback(err);
-			return;
-		}
-
-		if(body.match(/<h2>Access Denied<\/h2>/)) {
-			return callback(new Error("Access Denied"));
-		}
-
-		if(body.match(/You must have a validated email address to create a Steam Web API key./)) {
-			return callback(new Error("You must have a validated email address to create a Steam Web API key."));
-		}
-
-		var match = body.match(/<p>Key: ([0-9A-F]+)<\/p>/);
-		if(match) {
-			// We already have an API key registered
-			callback(null, match[1]);
-		} else {
-			// We need to register a new API key
-			self.httpRequestPost('https://steamcommunity.com/dev/registerkey?l=english', {
-				"form": {
-					"domain": domain,
-					"agreeToTerms": "agreed",
-					"sessionid": self.getSessionID(),
-					"Submit": "Register"
-				}
-			}, function(err, response, body) {
-				if (err) {
-					callback(err);
-					return;
-				}
-
-				self.getWebApiKey(domain, callback);
-			}, "steamcommunity");
-		}
-	}, "steamcommunity");
-};
-
-/**
- * @deprecated No longer works. Will be removed in a future release.
- * @param {function} callback
- */
-SteamCommunity.prototype.getWebApiOauthToken = function(callback) {
-	if (this.oAuthToken) {
-		return callback(null, this.oAuthToken);
-	}
-
-	callback(new Error('This operation requires an OAuth token, which is no longer issued by Steam.'));
-};
-
-/**
- * Sets an access_token generated by steam-session using EAuthTokenPlatformType.MobileApp.
- * Required for some operations such as 2FA enabling and disabling.
- * This will throw an Error if the provided token is not valid, was not generated for the MobileApp platform, is expired,
- * or does not belong to the logged-in user account.
- *
- * @param {string} token
- */
-SteamCommunity.prototype.setMobileAppAccessToken = function(token) {
-	if (!this.steamID) {
-		throw new Error('Log on to steamcommunity before setting a mobile app access token');
-	}
-
-	let decodedToken = Helpers.decodeJwt(token);
-
-	if (!decodedToken.iss || !decodedToken.sub || !decodedToken.aud || !decodedToken.exp) {
-		throw new Error('Provided value is not a valid Steam access token');
-	}
-
-	if (decodedToken.iss == 'steam') {
-		throw new Error('Provided token is a refresh token, not an access token');
-	}
-
-	if (decodedToken.sub != this.steamID.getSteamID64()) {
-		throw new Error(`Provided token belongs to account ${decodedToken.sub}, but we are logged into ${this.steamID.getSteamID64()}`);
-	}
-
-	if (decodedToken.exp < Math.floor(Date.now() / 1000)) {
-		throw new Error('Provided token is expired');
-	}
-
-	if ((decodedToken.aud || []).indexOf('mobile') == -1) {
-		throw new Error('Provided token is not valid for MobileApp platform type');
-	}
-
-	this.mobileAccessToken = token;
-};
-
-/**
- * Verifies that the mobile access token we already have set is still valid for current login.
- *
- * @private
- */
-SteamCommunity.prototype._verifyMobileAccessToken = function() {
-	if (!this.mobileAccessToken) {
-		// No access token, so nothing to do here.
-		return;
-	}
-
-	let decodedToken = Helpers.decodeJwt(this.mobileAccessToken);
-
-	let isTokenInvalid = decodedToken.sub != this.steamID.getSteamID64()    // SteamID doesn't match
-		|| decodedToken.exp < Math.floor(Date.now() / 1000);                      // Token is expired
-
-	if (isTokenInvalid) {
-		delete this.mobileAccessToken;
-	}
-};
+var SteamCommunity = require('../index.js');
+
+const Helpers = require('./helpers.js');
+
+SteamCommunity.prototype.getWebApiKey = function(domain, callback) {
+	var self = this;
+	this.httpRequest({
+		"uri": "https://steamcommunity.com/dev/apikey?l=english",
+		"followRedirect": false
+	}, function(err, response, body) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if(body.match(/<h2>Access Denied<\/h2>/)) {
+			return callback(new Error("Access Denied"));
+		}
+
+		if(body.match(/You must have a validated email address to create a Steam Web API key./)) {
+			return callback(new Error("You must have a validated email address to create a Steam Web API key."));
+		}
+
+		var match = body.match(/<p>Key: ([0-9A-F]+)<\/p>/);
+		if(match) {
+			// We already have an API key registered
+			callback(null, match[1]);
+		} else {
+			// We need to register a new API key
+			self.httpRequestPost('https://steamcommunity.com/dev/registerkey?l=english', {
+				"form": {
+					"domain": domain,
+					"agreeToTerms": "agreed",
+					"sessionid": self.getSessionID(),
+					"Submit": "Register"
+				}
+			}, function(err, response, body) {
+				if (err) {
+					callback(err);
+					return;
+				}
+
+				self.getWebApiKey(domain, callback);
+			}, "steamcommunity");
+		}
+	}, "steamcommunity");
+};
+
+/**
+ * @deprecated No longer works. Will be removed in a future release.
+ * @param {function} callback
+ */
+SteamCommunity.prototype.getWebApiOauthToken = function(callback) {
+	if (this.oAuthToken) {
+		return callback(null, this.oAuthToken);
+	}
+
+	callback(new Error('This operation requires an OAuth token, which is no longer issued by Steam.'));
+};
+
+/**
+ * Sets an access_token generated by steam-session using EAuthTokenPlatformType.MobileApp.
+ * Required for some operations such as 2FA enabling and disabling.
+ * This will throw an Error if the provided token is not valid, was not generated for the MobileApp platform, is expired,
+ * or does not belong to the logged-in user account.
+ *
+ * @param {string} token
+ */
+SteamCommunity.prototype.setMobileAppAccessToken = function(token) {
+	if (!this.steamID) {
+		throw new Error('Log on to steamcommunity before setting a mobile app access token');
+	}
+
+	let decodedToken = Helpers.decodeJwt(token);
+
+	if (!decodedToken.iss || !decodedToken.sub || !decodedToken.aud || !decodedToken.exp) {
+		throw new Error('Provided value is not a valid Steam access token');
+	}
+
+	if (decodedToken.iss == 'steam') {
+		throw new Error('Provided token is a refresh token, not an access token');
+	}
+
+	if (decodedToken.sub != this.steamID.getSteamID64()) {
+		throw new Error(`Provided token belongs to account ${decodedToken.sub}, but we are logged into ${this.steamID.getSteamID64()}`);
+	}
+
+	if (decodedToken.exp < Math.floor(Date.now() / 1000)) {
+		throw new Error('Provided token is expired');
+	}
+
+	if ((decodedToken.aud || []).indexOf('mobile') == -1) {
+		throw new Error('Provided token is not valid for MobileApp platform type');
+	}
+
+	this.mobileAccessToken = token;
+};
+
+/**
+ * Verifies that the mobile access token we already have set is still valid for current login.
+ *
+ * @private
+ */
+SteamCommunity.prototype._verifyMobileAccessToken = function() {
+	if (!this.mobileAccessToken) {
+		// No access token, so nothing to do here.
+		return;
+	}
+
+	let decodedToken = Helpers.decodeJwt(this.mobileAccessToken);
+
+	let isTokenInvalid = decodedToken.sub != this.steamID.getSteamID64()    // SteamID doesn't match
+		|| decodedToken.exp < Math.floor(Date.now() / 1000);                      // Token is expired
+
+	if (isTokenInvalid) {
+		delete this.mobileAccessToken;
+	}
+};

package/examples/edit-group-announcement.js

@@ -1,118 +1,118 @@
-var SteamCommunity = require('../index.js');
-var ReadLine = require('readline');
-
-var community = new SteamCommunity();
-var rl = ReadLine.createInterface({
-	"input": process.stdin,
-	"output": process.stdout
-});
-
-rl.question("Username: ", function(accountName) {
-	rl.question("Password: ", function(password) {
-		doLogin(accountName, password);
-	});
-});
-
-function doLogin(accountName, password, authCode, twoFactorCode, captcha) {
-	community.login({
-		"accountName": accountName,
-		"password": password,
-		"authCode": authCode,
-		"twoFactorCode": twoFactorCode,
-		"captcha": captcha
-	}, function(err, sessionID, cookies, steamguard) {
-		if(err) {
-			if(err.message == 'SteamGuardMobile') {
-				rl.question("Steam Authenticator Code: ", function(code) {
-					doLogin(accountName, password, null, code);
-				});
-
-				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) {
-					doLogin(accountName, password, code);
-				});
-
-				return;
-			}
-
-			if(err.message == 'CAPTCHA') {
-				console.log(err.captchaurl);
-				rl.question("CAPTCHA: ", function(captchaInput) {
-					doLogin(accountName, password, authCode, twoFactorCode, captchaInput);
-				});
-
-				return;
-			}
-
-			console.log(err);
-			process.exit();
-			return;
-		}
-
-		console.log("Logged on!");
-
-		rl.question("Group ID: ", function(gid) {
-			community.getSteamGroup(gid, function(err, group) {
-				if (err) {
-					console.log(err);
-					process.exit(1);
-				}
-
-				group.getAllAnnouncements(function(err, announcements) {
-
-					if(announcements.length === 0) {
-						return console.log("This group has no announcements");
-					}
-
-					for (var i = announcements.length - 1; i >= 0; i--) {
-						console.log("[%s] %s %s: %s", announcements[i].date, announcements[i].aid, announcements[i].author, announcements[i].content);
-					};
-
-					rl.question("Would you like to delete delete or edit an annoucement? (Type edit/delete): ", function(choice) {
-						rl.question("Annoucement ID: ", function(aid) {
-							if(choice === 'edit') {
-								rl.question("New title: ", function(header) {
-									rl.question("New body: ", function(content) {
-										// EW THE PYRAMID!
-										// Try replace this with delete!
-										editAnnouncement(group, aid, header, content);
-									});
-								});
-							} else {
-								deleteAnnouncement(group, aid);
-							}
-						});
-					});
-				});
-			});
-		});
-	});
-}
-
-function editAnnouncement(group, aid, header, content) {
-	// Actual community method.
-	group.editAnnouncement(aid, header, content, function(error) {
-		if(!error) {
-			console.log("Annoucement edited!");
-		} else {
-			console.log("Unable to edit annoucement! %j", error);
-			process.exit(1);
-		}
-	});
-}
-
-function deleteAnnouncement(group, aid) {
-	// group.deleteAnnouncement(aid);
-	// Or
-	group.deleteAnnouncement(aid, function(err) {
-		if(!err) {
-			console.log("Deleted");
-		} else {
-			console.log("Error deleting announcement.");
-		}
-	})
-}
+var SteamCommunity = require('../index.js');
+var ReadLine = require('readline');
+
+var community = new SteamCommunity();
+var rl = ReadLine.createInterface({
+	"input": process.stdin,
+	"output": process.stdout
+});
+
+rl.question("Username: ", function(accountName) {
+	rl.question("Password: ", function(password) {
+		doLogin(accountName, password);
+	});
+});
+
+function doLogin(accountName, password, authCode, twoFactorCode, captcha) {
+	community.login({
+		"accountName": accountName,
+		"password": password,
+		"authCode": authCode,
+		"twoFactorCode": twoFactorCode,
+		"captcha": captcha
+	}, function(err, sessionID, cookies, steamguard) {
+		if(err) {
+			if(err.message == 'SteamGuardMobile') {
+				rl.question("Steam Authenticator Code: ", function(code) {
+					doLogin(accountName, password, null, code);
+				});
+
+				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) {
+					doLogin(accountName, password, code);
+				});
+
+				return;
+			}
+
+			if(err.message == 'CAPTCHA') {
+				console.log(err.captchaurl);
+				rl.question("CAPTCHA: ", function(captchaInput) {
+					doLogin(accountName, password, authCode, twoFactorCode, captchaInput);
+				});
+
+				return;
+			}
+
+			console.log(err);
+			process.exit();
+			return;
+		}
+
+		console.log("Logged on!");
+
+		rl.question("Group ID: ", function(gid) {
+			community.getSteamGroup(gid, function(err, group) {
+				if (err) {
+					console.log(err);
+					process.exit(1);
+				}
+
+				group.getAllAnnouncements(function(err, announcements) {
+
+					if(announcements.length === 0) {
+						return console.log("This group has no announcements");
+					}
+
+					for (var i = announcements.length - 1; i >= 0; i--) {
+						console.log("[%s] %s %s: %s", announcements[i].date, announcements[i].aid, announcements[i].author, announcements[i].content);
+					};
+
+					rl.question("Would you like to delete delete or edit an annoucement? (Type edit/delete): ", function(choice) {
+						rl.question("Annoucement ID: ", function(aid) {
+							if(choice === 'edit') {
+								rl.question("New title: ", function(header) {
+									rl.question("New body: ", function(content) {
+										// EW THE PYRAMID!
+										// Try replace this with delete!
+										editAnnouncement(group, aid, header, content);
+									});
+								});
+							} else {
+								deleteAnnouncement(group, aid);
+							}
+						});
+					});
+				});
+			});
+		});
+	});
+}
+
+function editAnnouncement(group, aid, header, content) {
+	// Actual community method.
+	group.editAnnouncement(aid, header, content, function(error) {
+		if(!error) {
+			console.log("Annoucement edited!");
+		} else {
+			console.log("Unable to edit annoucement! %j", error);
+			process.exit(1);
+		}
+	});
+}
+
+function deleteAnnouncement(group, aid) {
+	// group.deleteAnnouncement(aid);
+	// Or
+	group.deleteAnnouncement(aid, function(err) {
+		if(!err) {
+			console.log("Deleted");
+		} else {
+			console.log("Error deleting announcement.");
+		}
+	})
+}

package/package.json

@@ -1,7 +1,14 @@
 {
 	"name": "steamcommunity",
-	"version": "3.46.1",
+	"version": "3.47.0",
 	"description": "Provides an interface for logging into and interacting with the Steam Community website",
+	"files": [
+		"/classes",
+		"/components",
+		"/examples",
+		"/resources",
+		"/index.js"
+	],
 	"keywords": [
 		"steam",
 		"steam community"
@@ -28,7 +35,7 @@
 		"request": "^2.88.0",
 		"steam-totp": "^1.5.0",
 		"steamid": "^1.1.3",
-		"xml2js": "^0.4.22"
+		"xml2js": "^0.6.2"
 	},
 	"devDependencies": {
 		"steam-session": "^1.2.3"

package/resources/EChatState.js

@@ -1,14 +1,14 @@
-/**
- * @enum EChatState
- */
-module.exports = {
-	"Offline": 0,
-	"LoggingOn": 1,
-	"LogOnFailed": 2,
-	"LoggedOn": 3,
-
-	"0": "Offline",
-	"1": "LoggingOn",
-	"2": "LogOnFailed",
-	"3": "LoggedOn"
-};
+/**
+ * @enum EChatState
+ */
+module.exports = {
+	"Offline": 0,
+	"LoggingOn": 1,
+	"LogOnFailed": 2,
+	"LoggedOn": 3,
+
+	"0": "Offline",
+	"1": "LoggingOn",
+	"2": "LogOnFailed",
+	"3": "LoggedOn"
+};

package/resources/EConfirmationType.js

@@ -1,12 +1,12 @@
-/**
- * @enum EConfirmationType
- */
-module.exports = {
-	// 1 is unknown, possibly "Invalid"
-	"Trade": 2,
-	"MarketListing": 3,
-	// 4 is opt-out or other like account confirmation?
-
-	"2": "Trade",
-	"3": "MarketListing"
-};
+/**
+ * @enum EConfirmationType
+ */
+module.exports = {
+	// 1 is unknown, possibly "Invalid"
+	"Trade": 2,
+	"MarketListing": 3,
+	// 4 is opt-out or other like account confirmation?
+
+	"2": "Trade",
+	"3": "MarketListing"
+};

package/resources/EFriendRelationship.js

@@ -1,23 +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",
-};
+/**
+ * @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

@@ -1,23 +1,23 @@
-/**
- * @enum EPersonaState
- */
-module.exports = {
-	"Offline": 0,
-	"Online": 1,
-	"Busy": 2,
-	"Away": 3,
-	"Snooze": 4,
-	"LookingToTrade": 5,
-	"LookingToPlay": 6,
-	"Invisible": 7,
-
-	// Value-to-name mapping for convenience
-	"0": "Offline",
-	"1": "Online",
-	"2": "Busy",
-	"3": "Away",
-	"4": "Snooze",
-	"5": "LookingToTrade",
-	"6": "LookingToPlay",
-	"7": "Invisible",
-};
+/**
+ * @enum EPersonaState
+ */
+module.exports = {
+	"Offline": 0,
+	"Online": 1,
+	"Busy": 2,
+	"Away": 3,
+	"Snooze": 4,
+	"LookingToTrade": 5,
+	"LookingToPlay": 6,
+	"Invisible": 7,
+
+	// Value-to-name mapping for convenience
+	"0": "Offline",
+	"1": "Online",
+	"2": "Busy",
+	"3": "Away",
+	"4": "Snooze",
+	"5": "LookingToTrade",
+	"6": "LookingToPlay",
+	"7": "Invisible",
+};