steamapi - npm Package Compare versions

Comparing version 1.3.2 to 1.3.3

package.json

@@ -5,3 +5,3 @@ {
   "main": "index.js",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "keywords": [
@@ -14,15 +14,19 @@ "steam",
   ],
-  "maintainers": [{
-    "name": "Dim",
-    "email": "[e-mail]",
-    "web": "https://dim.codes"
-  }],
+  "maintainers": [
+    {
+      "name": "Dim",
+      "email": "[e-mail]",
+      "web": "https://dim.codes"
+    }
+  ],
   "bugs": {
     "web": "https://github.com/lloti/node-steamapi/issues"
   },
-  "repositories": [{
-    "type": "git",
-    "url": "https://github.com/lloti/node-steamapi"
-  }],
+  "repositories": [
+    {
+      "type": "git",
+      "url": "https://github.com/lloti/node-steamapi"
+    }
+  ],
   "homepage": "https://github.com/lloti/node-steamapi#readme"
-}
+}

src/Fetch.js

@@ -14,6 +14,6 @@ const http = require('http');
       res.once('end', () => {
-        if (res.statusCode === 500) return reject('internal server error');
-        if (res.statusCode === 403) return reject('invalid key');
-        if (res.statusCode === 400) return reject('invalid parameters');
-        if (res.statusCode !== 200) return reject(res.statusMessage);
+        if (res.statusCode === 500) return reject(new Error('internal server error'));
+        if (res.statusCode === 403) return reject(new Error('invalid key'));
+        if (res.statusCode === 400) return reject(new Error('invalid parameters'));
+        if (res.statusCode !== 200) return reject(new Error(res.statusMessage));
         try {
@@ -23,3 +23,3 @@ const json = JSON.parse(data);
         } catch(error) {
-          reject(error);
+          reject(new Error(error));
         }
@@ -26,0 +26,0 @@ });

src/SteamAPI.js

@@ -8,420 +8,443 @@ const fetch = require('./Fetch');
 class SteamAPI {
-  /**
-   * Sets Steam key for future use
-   * @param {string} key Steam key
-   */
-  constructor(key) {
-    if (!key) console.log('no key provided | some methods may not work | go get one > https://goo.gl/DfNy5s');
-    this.baseURL = 'https://api.steampowered.com';
-    this.key = key;
-    this.headers = {
-      'User-Agent': `SteamAPI/${version} https://www.npmjs.com/package/steamapi`
-    };
-  }
+	/**
+	 * Sets Steam key for future use
+	 * @param {string} key Steam key
+	 * @param {Object} [cache={}] Optional options for caching `getGameDetails()`
+	 * @param {boolean} [cache.enabled=true] Whether to cache or not
+	 * @param {number} [cache.expires=86400000] How long cache should last for (ms) [1 day by default]
+	 */
+	constructor(key, cache = {}) {
+		if (!key) console.log('no key provided | some methods may not work | go get one > https://goo.gl/DfNy5s');
+		this.baseURL = 'https://api.steampowered.com';
+		this.key = key;
+		this.headers = {
+			'User-Agent': `SteamAPI/${version} https://www.npmjs.com/package/steamapi`
+		};
+		this.options = {
+			enabled: cache.enabled || true,
+			expires: cache.expires || 86400000
+		};
+		if (this.options.enabled) this.cache = new Map();
+	}
 
-  /**
-   * Get custom path that isn't in SteamAPI
-   * @param {string} path Path to request e.g '/IPlayerService/GetOwnedGames/v1?steamid=76561198378422474'
-   * @returns {Promise<Object>} JSON Response
-   */
-  get(path) {
-    return new Promise((resolve, reject) => {
-      fetch(`${this.baseURL}${path}${path.includes('?') ? '&' : '?'}key=${this.key}`, this.headers)
-        .then(resolve)
-        .catch(reject);
-    });
-  }
+	/**
+	 * Get custom path that isn't in SteamAPI
+	 * @param {string} path Path to request e.g '/IPlayerService/GetOwnedGames/v1?steamid=76561198378422474'
+	 * @returns {Promise<Object>} JSON Response
+	 */
+	get(path) {
+		return new Promise((resolve, reject) => {
+			fetch(`${this.baseURL}${path}${path.includes('?') ? '&' : '?'}key=${this.key}`, this.headers)
+				.then(resolve)
+				;
+		});
+	}
 
-  /**
-   * Resolve info based on id|profile|url
-   * @param {string} info Something to resolve e.g 'https://steamcommunity.com/id/xDim'
-   * @returns {Promise<string>} Profile ID
-   */
-  resolve(info) {
-    return new Promise(async (resolve, reject) => {
-      if (!info) return reject('no info provided');
-      let steamID, steamURL;
-      if (/^(?:\/?profiles\/)?\d{17}.*$/.test(info)) {
-        steamID = info.replace(/^(?:\/?profiles\/)?(\d{17}).*$/, '$1');
-      } else if (/^(?:\/?id\/)?\w{2,32}.*$/.test(info)) {
-        steamURL = info.replace(/^(?:\/?id\/)?(\w{2,32}).*$/, '$1');
-      } else {
-        const url = parse(info);
-        if (url.hostname === 'steamcommunity.com') {
-          if (url.path.startsWith('/id/')) {
-            steamURL = url.path.replace(/\/id\//, '');
-          } else if (url.path.startsWith('/profiles/')) {
-            steamID = url.path.replace(/\/profiles\//, '');
-          } else {
-            return reject('Invalid profile link/id');
-          }
-        }
-      }
-      if (steamURL) {
-        steamID = await fetch(`${this.baseURL}/ISteamUser/ResolveVanityURL/v1?key=${this.key}&vanityurl=${steamURL}`, this.headers)
-          .then(json => json.response.success === 1 ? json.response.steamid : reject('Invalid profile link/id'))
-          .catch(reject);
-      }
-      resolve(steamID);
-    });
-  }
+	/**
+	 * Resolve info based on id|profile|url
+	 * @param {string} info Something to resolve e.g 'https://steamcommunity.com/id/xDim'
+	 * @returns {Promise<string>} Profile ID
+	 */
+	resolve(info) {
+		return new Promise(async (resolve, reject) => {
+			if (!info) return reject('no info provided');
+			let steamID, steamURL;
+			if (/^(?:\/?profiles\/)?\d{17}.*$/.test(info)) {
+				steamID = info.replace(/^(?:\/?profiles\/)?(\d{17}).*$/, '$1');
+			} else if (/^(?:\/?id\/)?\w{2,32}.*$/.test(info)) {
+				steamURL = info.replace(/^(?:\/?id\/)?(\w{2,32}).*$/, '$1');
+			} else {
+				const url = parse(info);
+				if (url.hostname === 'steamcommunity.com') {
+					if (url.path.startsWith('/id/')) {
+						steamURL = url.path.replace(/\/id\//, '');
+					} else if (url.path.startsWith('/profiles/')) {
+						steamID = url.path.replace(/\/profiles\//, '');
+					} else {
+						return reject('Invalid profile link/id');
+					}
+				}
+			}
+			if (steamURL) {
+				steamID = await fetch(`${this.baseURL}/ISteamUser/ResolveVanityURL/v1?key=${this.key}&vanityurl=${steamURL}`, this.headers)
+					.then(json => json.response.success === 1 ? json.response.steamid : reject('Invalid profile link/id'))
+					;
+			}
+			resolve(steamID);
+		});
+	}
 
-  /**
-   * Get every single app on steam
-   * @returns {Promise<Array<Object>>} Objects consisting of appid and name
-   */
-  getAppList() {
-    return new Promise(async (resolve, reject) => {
-      const json = await fetch(`${this.baseURL}/ISteamApps/GetAppList/v2`, this.headers).catch(reject);
-      resolve(json.applist.apps);
-    });
-  }
-  
-  /**
-   * Get featured categories on the steam store
-   * @returns {Promise<Object>>} Featured categories
-   */
-  getFeaturedCategories() {
-    return new Promise(async (resolve, reject) => {
-      const json = await fetch('https://store.steampowered.com/api/featuredcategories', this.headers).catch(reject);
-      resolve(json);
-    });
-  }
-  
-  /**
-   * Get featured games on the steam store
-   * @returns {Promise<Object>>} Featured games
-   */
-  getFeaturedGames() {
-    return new Promise(async (resolve, reject) => {
-      const json = await fetch('https://store.steampowered.com/api/featured', this.headers).catch(reject);
-      resolve(json);
-    });
-  }
+	/**
+	 * Get every single app on steam
+	 * @returns {Promise<Array<Object>>} Objects consisting of appid and name
+	 */
+	getAppList() {
+		return new Promise(async (resolve, reject) => {
+			const json = await fetch(`${this.baseURL}/ISteamApps/GetAppList/v2`, this.headers);
+			resolve(json.applist.apps);
+		});
+	}
+	
+	/**
+	 * Get featured categories on the steam store
+	 * @returns {Promise<Object>>} Featured categories
+	 */
+	getFeaturedCategories() {
+		return new Promise(async (resolve, reject) => {
+			const json = await fetch('https://store.steampowered.com/api/featuredcategories', this.headers);
+			resolve(json);
+		});
+	}
+	
+	/**
+	 * Get featured games on the steam store
+	 * @returns {Promise<Object>>} Featured games
+	 */
+	getFeaturedGames() {
+		return new Promise(async (resolve, reject) => {
+			const json = await fetch('https://store.steampowered.com/api/featured', this.headers);
+			resolve(json);
+		});
+	}
 
-  /**
-   * Get achievements for app id
-   * @param {string} app App ID
-   * @returns {Promise<Array<string>>} App achievements for ID
-   */
-  getGameAchievements(app) {
-    return new Promise(async (resolve, reject) => {
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2?gameid=${app}`, this.headers).catch(reject);
-      resolve(json.achievementpercentages.achievements);
-    });
-  }
+	/**
+	 * Get achievements for app id
+	 * @param {string} app App ID
+	 * @returns {Promise<Array<string>>} App achievements for ID
+	 */
+	getGameAchievements(app) {
+		return new Promise(async (resolve, reject) => {
+			if (!appReg.test(app)) return reject('no appid provided');
+			const json = await fetch(`${this.baseURL}/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2?gameid=${app}`, this.headers);
+			resolve(json.achievementpercentages.achievements);
+		});
+	}
 
-  /**
-   * Get details for app id
-   * @param {string} app App ID
-   * @returns {Promise<Object>>} App details for ID
-   */
-  getGameDetails(app) {
-    return new Promise(async (resolve, reject) => {
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`https://store.steampowered.com/api/appdetails?appids=${app}`, this.headers).catch(reject);
-      if (!json[app].success) return reject('no app found');
-      resolve(json[app].data);
-    });
-  }
+	/**
+	 * Get details for app id
+	 * <warn>Requests for this endpoint are limited to 200 every 5 minutes</warn> 
+	 * @param {string} app App ID
+	 * @param {boolean} force Overwrite cache
+	 * @returns {Promise<Object>>} App details for ID
+	 */
+	getGameDetails(app, force) {
+		return new Promise(async (resolve, reject) => {
+			if (!appReg.test(app)) return reject('no appid provided');
+			app = app.toString();
+			if (this.options.enabled) {
+				if (force || (this.cache.has(app) && this.cache.get(app).expires <= Date.now()) || !this.cache.has(app)) {
+					const json = await fetch(`https://store.steampowered.com/api/appdetails?appids=${app}`, this.headers);
+					if (!json[app].success) return reject('no app found');
+					this.cache.set(app, {
+						data: json[app].data,
+						expires: Date.now() + this.options.expires
+					});
+				}
+			} else {
+				const json = await fetch(`https://store.steampowered.com/api/appdetails?appids=${app}`, this.headers);
+				if (!json[app].success) return reject('no app found');
+				return resolve(json[app].data);
+			}
+			resolve(this.cache.get(app).data);
+		});
+	}
 
-  /**
-   * Get news for app id
-   * @param {string} app App ID
-   * @returns {Promise<Array<Object>>} App news for ID
-   */
-  getGameNews(app) {
-    return new Promise(async (resolve, reject) => {
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`${this.baseURL}/ISteamNews/GetNewsForApp/v2?appid=${app}`, this.headers).catch(reject);
-      if (json.appnews.count === 0) return reject('no news found');
-      resolve(json.appnews.newsitems);
-    });
-  }
+	/**
+	 * Get news for app id
+	 * @param {string} app App ID
+	 * @returns {Promise<Array<Object>>} App news for ID
+	 */
+	getGameNews(app) {
+		return new Promise(async (resolve, reject) => {
+			if (!appReg.test(app)) return reject('no appid provided');
+			const json = await fetch(`${this.baseURL}/ISteamNews/GetNewsForApp/v2?appid=${app}`, this.headers);
+			if (json.appnews.count === 0) return reject('no news found');
+			resolve(json.appnews.newsitems);
+		});
+	}
 
-  /**
-   * Get number of current players for app id
-   * @param {string} app App ID
-   * @returns {Promise<number>} Number of players
-   */
-  getGamePlayers(app) {
-    return new Promise(async (resolve, reject) => {
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetNumberOfCurrentPlayers/v1?appid=${app}`, this.headers).catch(reject);
-      if (json.response.result !== 1) return reject('invalid app id');
-      resolve(json.response.player_count);
-    });
-  }
+	/**
+	 * Get number of current players for app id
+	 * @param {string} app App ID
+	 * @returns {Promise<number>} Number of players
+	 */
+	getGamePlayers(app) {
+		return new Promise(async (resolve, reject) => {
+			if (!appReg.test(app)) return reject('no appid provided');
+			const json = await fetch(`${this.baseURL}/ISteamUserStats/GetNumberOfCurrentPlayers/v1?appid=${app}`, this.headers);
+			if (json.response.result !== 1) return reject('invalid app id');
+			resolve(json.response.player_count);
+		});
+	}
 
-  /**
-   * Get schema for app id
-   * @param {string} app App ID
-   * @returns {Promise<number>} Schema
-   */
-  getGameSchema(app) {
-    return new Promise(async (resolve, reject) => {
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetSchemaForGame/v2?key=${this.key}&appid=${app}`, this.headers).catch(reject);
-      if (!json.game) return reject('game not found');
-      resolve(json.game);
-    });
-  }
+	/**
+	 * Get schema for app id
+	 * @param {string} app App ID
+	 * @returns {Promise<number>} Schema
+	 */
+	getGameSchema(app) {
+		return new Promise(async (resolve, reject) => {
+			if (!appReg.test(app)) return reject('no appid provided');
+			const json = await fetch(`${this.baseURL}/ISteamUserStats/GetSchemaForGame/v2?key=${this.key}&appid=${app}`, this.headers);
+			if (!json.game) return reject('game not found');
+			resolve(json.game);
+		});
+	}
 
-  /**
-   * Get every server associated with ip
-   * @param {string} ip IP to request
-   * @returns {Promise<Array<Object>>} Objects consisting of server info
-   */
-  getServers(ip) {
-    return new Promise(async (resolve, reject) => {
-      if (!ipReg.test(ip)) return reject('no ip provided');
-      const json = await fetch(`${this.baseURL}/ISteamApps/GetServersAtAddress/v1?addr=${ip}`, this.headers).catch(reject);
-      if (!json.response.success) return reject('invalid ip');
-      resolve(json.response.servers.map(server => ({
-        address: server.addr,
-        appID: server.appid,
-        game: server.gamedir,
-        gmsindex: server.gmsindex,
-        lan: server.lan,
-        port: server.gameport,
-        region: server.region,
-        secure: server.secure,
-        specPort: server.specPort
-      })));
-    });
-  }
+	/**
+	 * Get every server associated with ip
+	 * @param {string} ip IP to request
+	 * @returns {Promise<Array<Object>>} Objects consisting of server info
+	 */
+	getServers(ip) {
+		return new Promise(async (resolve, reject) => {
+			if (!ipReg.test(ip)) return reject('no ip provided');
+			const json = await fetch(`${this.baseURL}/ISteamApps/GetServersAtAddress/v1?addr=${ip}`, this.headers);
+			if (!json.response.success) return reject('invalid ip');
+			resolve(json.response.servers.map(server => ({
+				address: server.addr,
+				appID: server.appid,
+				game: server.gamedir,
+				gmsindex: server.gmsindex,
+				lan: server.lan,
+				port: server.gameport,
+				region: server.region,
+				secure: server.secure,
+				specPort: server.specPort
+			})));
+		});
+	}
 
-  /**
-   * Get users achievements for app id
-   * @param {string} id User ID
-   * @param {string} app App ID
-   * @returns {Promise<Object>} Achievements
-   */
-  getUserAchievements(id, app) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no user id provided');
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetPlayerAchievements/v1?key=${this.key}&steamid=${id}&appid=${app}`, this.headers).catch(reject);
-      const stats = json.playerstats;
-      if (!stats.success) return reject('error getting achievements');
-      resolve({
-        gameName: stats.gameName,
-        steamID: stats.steamID,
-        achievements: stats.achievements.map(achievement => ({
-          api: achievement.apiname,
-          achieved: achievement.achieved ? true : false,
-          unlockTime: achievement.unlocktime
-        }))
-      });
-    });
-  }
+	/**
+	 * Get users achievements for app id
+	 * @param {string} id User ID
+	 * @param {string} app App ID
+	 * @returns {Promise<Object>} Achievements
+	 */
+	getUserAchievements(id, app) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no user id provided');
+			if (!appReg.test(app)) return reject('no appid provided');
+			const json = await fetch(`${this.baseURL}/ISteamUserStats/GetPlayerAchievements/v1?key=${this.key}&steamid=${id}&appid=${app}`, this.headers);
+			const stats = json.playerstats;
+			if (!stats.success) return reject('error getting achievements');
+			resolve({
+				gameName: stats.gameName,
+				steamID: stats.steamID,
+				achievements: stats.achievements.map(achievement => ({
+					api: achievement.apiname,
+					achieved: achievement.achieved ? true : false,
+					unlockTime: achievement.unlocktime
+				}))
+			});
+		});
+	}
 
-  /**
-   * Get users badges
-   * @param {string} id User ID
-   * @returns {Promise<Array<Object>>} Badges
-   */
-  getUserBadges(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/IPlayerService/GetBadges/v1?key=${this.key}&steamid=${id}`, this.headers).catch(reject);
-      resolve(json.response.badges.map(badge => ({
-        appID: badge.appid,
-        badgeID: badge.badgeid,
-        borderColor: badge.border_color,
-        communityItemID: badge.communityitemid,
-        completionTime: badge.completion_time,
-        level: badge.level,
-        scarcity: badge.scarcity,
-        xp: badge.xp
-      })));
-    });
-  }
+	/**
+	 * Get users badges
+	 * @param {string} id User ID
+	 * @returns {Promise<Array<Object>>} Badges
+	 */
+	getUserBadges(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/IPlayerService/GetBadges/v1?key=${this.key}&steamid=${id}`, this.headers);
+			resolve(json.response.badges.map(badge => ({
+				appID: badge.appid,
+				badgeID: badge.badgeid,
+				borderColor: badge.border_color,
+				communityItemID: badge.communityitemid,
+				completionTime: badge.completion_time,
+				level: badge.level,
+				scarcity: badge.scarcity,
+				xp: badge.xp
+			})));
+		});
+	}
 
-  /**
-   * Get users bans
-   * @param {string} id User ID
-   * @returns {Promise<Object>} Ban info
-   */
-  getUserBans(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/ISteamUser/GetPlayerBans/v1?key=${this.key}&steamids=${id}`, this.headers).catch(reject);
-      const ban = json.players[0];
-      resolve({
-        communityBanned: ban.CommunityBanned,
-        daysSinceLastBan: ban.DaysSinceLastBan,
-        economyBan: ban.EconomyBan,
-        numberOfVACBans: ban.NumberOfVACBans,
-        numberOfGameBans: ban.NumberOfGameBans,
-        steamID: ban.SteamID,
-        VACBanned: ban.VACBanned
-      });
-    });
-  }
+	/**
+	 * Get users bans
+	 * @param {string} id User ID
+	 * @returns {Promise<Object>} Ban info
+	 */
+	getUserBans(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/ISteamUser/GetPlayerBans/v1?key=${this.key}&steamids=${id}`, this.headers);
+			const ban = json.players[0];
+			resolve({
+				communityBanned: ban.CommunityBanned,
+				daysSinceLastBan: ban.DaysSinceLastBan,
+				economyBan: ban.EconomyBan,
+				numberOfVACBans: ban.NumberOfVACBans,
+				numberOfGameBans: ban.NumberOfGameBans,
+				steamID: ban.SteamID,
+				VACBanned: ban.VACBanned
+			});
+		});
+	}
 
-  /**
-   * Get users friends
-   * @param {string} id User ID
-   * @returns {Promise<Array<Object>>} Friends
-   */
-  getUserFriends(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/ISteamUser/GetFriendList/v1?key=${this.key}&steamid=${id}`, this.headers).catch(reject);
-      const friends = json.friendslist.friends;
-      const newFriends = [];
-      for (const friend of friends) {
-        newFriends.push({
-          steamID: friend.steamid,
-          relationship: friend.relationship,
-          friendSince: friend.friend_since
-        });
-      }
-      resolve(newFriends);
-    });
-  }
+	/**
+	 * Get users friends
+	 * @param {string} id User ID
+	 * @returns {Promise<Array<Object>>} Friends
+	 */
+	getUserFriends(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/ISteamUser/GetFriendList/v1?key=${this.key}&steamid=${id}`, this.headers);
+			const friends = json.friendslist.friends;
+			const newFriends = [];
+			for (const friend of friends) {
+				newFriends.push({
+					steamID: friend.steamid,
+					relationship: friend.relationship,
+					friendSince: friend.friend_since
+				});
+			}
+			resolve(newFriends);
+		});
+	}
 
-  /**
-   * Get users groups
-   * @param {string} id User ID
-   * @returns {Promise<Array<string>>} Groups
-   */
-  getUserGroups(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/ISteamUser/GetUserGroupList/v1?key=${this.key}&steamid=${id}`, this.headers).catch(reject);
-      if (!json.response.success) return reject('failed');
-      resolve(json.response.groups.map(group => group.gid));
-    });
-  }
+	/**
+	 * Get users groups
+	 * @param {string} id User ID
+	 * @returns {Promise<Array<string>>} Groups
+	 */
+	getUserGroups(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/ISteamUser/GetUserGroupList/v1?key=${this.key}&steamid=${id}`, this.headers);
+			if (!json.response.success) return reject('failed');
+			resolve(json.response.groups.map(group => group.gid));
+		});
+	}
 
-  /**
-   * Get users level
-   * @param {string} id User ID
-   * @returns {Promise<number>} Level
-   */
-  getUserLevel(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/IPlayerService/GetSteamLevel/v1?key=${this.key}&steamid=${id}`, this.headers).catch(reject);
-      resolve(json.response.player_level);
-    });
-  }
+	/**
+	 * Get users level
+	 * @param {string} id User ID
+	 * @returns {Promise<number>} Level
+	 */
+	getUserLevel(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/IPlayerService/GetSteamLevel/v1?key=${this.key}&steamid=${id}`, this.headers);
+			resolve(json.response.player_level);
+		});
+	}
 
-  /**
-   * Get users owned games
-   * @param {string} id User ID
-   * @returns {Promise<Array<Object>>} Owned games
-   */
-  getUserOwnedGames(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/IPlayerService/GetOwnedGames/v1?key=${this.key}&steamid=${id}`, this.headers).catch(reject);
-      resolve(json.response.games.map(game => ({
-        appID: game.appid,
-        playTime: game.playtime_forever,
-        playTime2: game.playtime_2weeks || null
-      })));
-    });
-  }
+	/**
+	 * Get users owned games
+	 * @param {string} id User ID
+	 * @returns {Promise<Array<Object>>} Owned games
+	 */
+	getUserOwnedGames(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/IPlayerService/GetOwnedGames/v1?key=${this.key}&steamid=${id}`, this.headers);
+			resolve(json.response.games.map(game => ({
+				appID: game.appid,
+				playTime: game.playtime_forever,
+				playTime2: game.playtime_2weeks || null
+			})));
+		});
+	}
 
-  /**
-   * Get users recent games
-   * @param {string} id User ID
-   * @returns {Promise<Array<Object>>} Recent games
-   */
-  getUserRecentGames(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/IPlayerService/GetRecentlyPlayedGames/v1?key=${this.key}&steamid=${id}`, this.headers).catch(reject);
-      resolve(json.response.games.map(game => ({
-        appID: game.appid,
-        logoURL: `https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/${game.appid}/${game.img_logo_url}.jpg`,
-        name: game.name,
-        iconURL: `https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/${game.appid}/${game.img_icon_url}.jpg`,
-        playTime: game.playtime_forever,
-        playTime2: game.playtime_2weeks
-      })));
-    });
-  }
+	/**
+	 * Get users recent games
+	 * @param {string} id User ID
+	 * @returns {Promise<Array<Object>>} Recent games
+	 */
+	getUserRecentGames(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/IPlayerService/GetRecentlyPlayedGames/v1?key=${this.key}&steamid=${id}`, this.headers);
+			resolve(json.response.games.map(game => ({
+				appID: game.appid,
+				logoURL: `https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/${game.appid}/${game.img_logo_url}.jpg`,
+				name: game.name,
+				iconURL: `https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/${game.appid}/${game.img_icon_url}.jpg`,
+				playTime: game.playtime_forever,
+				playTime2: game.playtime_2weeks
+			})));
+		});
+	}
 
-  /**
-   * Gets servers on steamcommunity.com/dev/managegameservers using your key or provided key
-   * @param {boolean} [hide=false] Hide deleted/expired servers
-   * @param {string} [key=this.key] Key
-   * @returns {Promise<Object>} Servers
-   */
-  getUserServers(hide = false, key = this.key) {
-    return new Promise(async (resolve, reject) => {
-      const json = await fetch(`${this.baseURL}/IGameServersService/GetAccountList/v1?key=${key}`, this.headers).catch(reject);
-      const response = json.response;
-      resolve({
-        actor: response.actor,
-        expires: response.expires,
-        banned: response.is_banned,
-        lastActionTime: response.last_action_time,
-        servers: response.servers.filter(server => hide && !(server.is_deleted || server.is_expired)).map(server => ({
-          appID: server.appid,
-          deleted: server.is_deleted,
-          expired: server.is_expired,
-          lastLoginTime: server.rt_last_logon,
-          memo: server.memo,
-          steamID: server.steamid,
-          token: server.login_token
-        }))
-      });
-    });
-  }
+	/**
+	 * Gets servers on steamcommunity.com/dev/managegameservers using your key or provided key
+	 * @param {boolean} [hide=false] Hide deleted/expired servers
+	 * @param {string} [key=this.key] Key
+	 * @returns {Promise<Object>} Servers
+	 */
+	getUserServers(hide = false, key = this.key) {
+		return new Promise(async (resolve, reject) => {
+			const json = await fetch(`${this.baseURL}/IGameServersService/GetAccountList/v1?key=${key}`, this.headers);
+			const response = json.response;
+			resolve({
+				actor: response.actor,
+				expires: response.expires,
+				banned: response.is_banned,
+				lastActionTime: response.last_action_time,
+				servers: response.servers.filter(server => hide && !(server.is_deleted || server.is_expired)).map(server => ({
+					appID: server.appid,
+					deleted: server.is_deleted,
+					expired: server.is_expired,
+					lastLoginTime: server.rt_last_logon,
+					memo: server.memo,
+					steamID: server.steamid,
+					token: server.login_token
+				}))
+			});
+		});
+	}
 
-  /**
-   * Get users stats for app id
-   * @param {string} id User ID
-   * @param {string} app App ID
-   * @returns {Promise<Object>} Stats for app id
-   */
-  getUserStats(id, app) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no user id provided');
-      if (!appReg.test(app)) return reject('no appid provided');
-      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetUserStatsForGame/v2?key=${this.key}&steamid=${id}&appid=${app}`, this.headers).catch(reject);
-      if (!json.playerstats) return reject('game not found for user');
-      resolve(json.playerstats);
-    });
-  }
+	/**
+	 * Get users stats for app id
+	 * @param {string} id User ID
+	 * @param {string} app App ID
+	 * @returns {Promise<Object>} Stats for app id
+	 */
+	getUserStats(id, app) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no user id provided');
+			if (!appReg.test(app)) return reject('no appid provided');
+			const json = await fetch(`${this.baseURL}/ISteamUserStats/GetUserStatsForGame/v2?key=${this.key}&steamid=${id}&appid=${app}`, this.headers);
+			if (!json.playerstats) return reject('game not found for user');
+			resolve(json.playerstats);
+		});
+	}
 
-  /**
-   * Get users summary
-   * @param {string} id User ID
-   * @returns {Promise<Object>} Summary
-   */
-  getUserSummary(id) {
-    return new Promise(async (resolve, reject) => {
-      if (!idReg.test(id)) return reject('no id provided');
-      const json = await fetch(`${this.baseURL}/ISteamUser/GetPlayerSummaries/v2?key=${this.key}&steamids=${id}`, this.headers).catch(reject);
-      const player = json.response.players[0];
-      if (!player) return reject('invalid id');
-      resolve({
-        avatar: {
-          small: player.avatar,
-          medium: player.avatarmedium,
-          large: player.avatarfull
-        },
-        commentPermission: player.commentpermission,
-        created: player.timecreated,
-        lastLogOff: player.lastlogoff,
-        nickname: player.personaname,
-        personaState: player.personastate,
-        personaStateFlags: player.personastateflags,
-        primaryGroupID: player.primaryclanid,
-        profileState: player.profilestate,
-        profileURL: player.profileurl,
-        steamID: player.steamid,
-        visibilityState: player.communityvisibilitystate
-      });
-    });
-  }
+	/**
+	 * Get users summary
+	 * @param {string} id User ID
+	 * @returns {Promise<Object>} Summary
+	 */
+	getUserSummary(id) {
+		return new Promise(async (resolve, reject) => {
+			if (!idReg.test(id)) return reject('no id provided');
+			const json = await fetch(`${this.baseURL}/ISteamUser/GetPlayerSummaries/v2?key=${this.key}&steamids=${id}`, this.headers);
+			const player = json.response.players[0];
+			if (!player) return reject('invalid id');
+			resolve({
+				avatar: {
+					small: player.avatar,
+					medium: player.avatarmedium,
+					large: player.avatarfull
+				},
+				commentPermission: player.commentpermission,
+				created: player.timecreated,
+				lastLogOff: player.lastlogoff,
+				nickname: player.personaname,
+				personaState: player.personastate,
+				personaStateFlags: player.personastateflags,
+				primaryGroupID: player.primaryclanid,
+				profileState: player.profilestate,
+				profileURL: player.profileurl,
+				steamID: player.steamid,
+				visibilityState: player.communityvisibilitystate
+			});
+		});
+	}
 }
 
-module.exports = SteamAPI;
+module.exports = SteamAPI;

New alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Lines of code

449

increased by5.15%

Worsened metrics

Total package byte prevSize

19607

decreased by-0.53%

Number of medium supply chain risk alerts

26

increased by4%

No dependency changes