steamapi - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

lib/app.js

@@ -1,3 +0,3 @@
-module.exports = require('./steam/UserStats');
+module.exports = require('./steam/API');
 
 // GameStats later

lib/steam/API.js

 const fetch = require('node-fetch');
-const { parse } = require('url');
 const { version } = require('../../package.json');
+const appReg = /^\d+$/;
+const idReg = /^\d{17}$/;
 
 class API {
-    constructor(data) {
-        if (!data) console.log('no key provided | some methods may not work | go get one > https://goo.gl/DfNy5s');
-        this.key = data;
-        this.headers = {
-            'User-Agent': `SteamAPI/${version} https://github.com/lloti/steampowered-api`
-        };
-    }
+  constructor(data) {
+    if (!data) 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 = data;
+    this.headers = {
+      'User-Agent': `SteamAPI/${version} https://github.com/lloti/steampowered-api`
+    };
+  }
+  get(path) {
+    return new Promise((resolve, reject) => {
+      fetch(`${this.baseURL}${path}${path.includes('?') ? '&' : '?'}key=${this.key}`)
+        .then(res => res.json())
+        .then(resolve)
+        .catch(reject);
+    });
+  }
+  getGameAchievements(app) {
+    if (!appReg.test(app)) throw new Error('no appid provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2?gameid=${app}`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      resolve(json.achievementpercentages.achievements);
+    });
+  }
+  getGameNews(app) {
+    if (!appReg.test(app)) throw new Error('no appid provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamNews/GetNewsForApp/v2?appid=${app}`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      if (json.appnews.count === 0) return reject('no news found');
+      resolve(json.appnews.newsitems);
+    });
+  }
+  getGamePlayers(app) {
+    if (!appReg.test(app)) throw new Error('no appid provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetNumberOfCurrentPlayers/v1?appid=${app}&count=1&name[0]`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      if (json.response.result !== 1) return reject('invalid app id');
+      resolve(json.response.player_count);
+    });
+  }
+  getGameSchema(app) {
+    if (!appReg.test(app)) throw new Error('no appid provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetSchemaForGame/v2?key=${this.key}&appid=${app}`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      if (!json.game) return reject('game not found');
+      resolve(json.game);
+    });
+  }
+  resolve(info) {
+    if (!info) throw new Error('no info provided');
+    return new Promise(async(resolve, reject) => {
+      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(res => res.json())
+          .then(json => json.response.success === 1 ? json.response.steamid : reject('Invalid profile link/id'))
+          .catch(reject);
+      }
+      resolve(steamID);
+    });
+  }
+  getUserAchievements(player, app) {
+    if (!idReg.test(player)) throw new Error('no player id provided');
+    if (!/^\d+$/.test(app)) throw new Error('no appid provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetPlayerAchievements/v1?key=${this.key}&steamid=${player}&appid=${app}`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      if (!json.playerstats.success) return reject('error getting achievements');
+      resolve(json.playerstats);
+    });
+  }
+  getUserBans(id) {
+    if (!idReg.test(id)) throw new Error('no id provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUser/GetPlayerBans/v1?key=${this.key}&steamids=${id}`, this.headers)
+        .then(res => res.json())
+        .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
+      });
+    });
+  }
+  getUserFriends(id) {
+    if (!idReg.test(id)) throw new Error('no id provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUser/GetFriendList/v1?key=${this.key}&steamid=${id}`, this.headers)
+        .then(res => res.json())
+        .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);
+    });
+  }
+  getUserGroups(id) {
+    if (!idReg.test(id)) throw new Error('no id provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUser/GetUserGroupList/v1?key=${this.key}&steamid=${id}`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      if (!json.response.success) return reject('failed');
+      resolve(json.response.groups.map(group => group.gid));
+    });
+  }
+  getUserStats(player, app) {
+    if (!idReg.test(player)) throw new Error('no player id provided');
+    if (!/^\d+$/.test(app)) throw new Error('no appid provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUserStats/GetUserStatsForGame/v2?key=${this.key}&steamid=${player}&appid=${app}`, this.headers)
+        .then(res => res.json())
+        .catch(reject);
+      if (!json.playerstats) return reject('game not found for user');
+      resolve(json.playerstats);
+    });
+  }
+  getUserSummary(id) {
+    if (!idReg.test(id)) throw new Error('no id provided');
+    return new Promise(async (resolve, reject) => {
+      const json = await fetch(`${this.baseURL}/ISteamUser/GetPlayerSummaries/v2?key=${this.key}&steamids=${id}`, this.headers)
+        .then(res => res.json())
+        .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
+      });
+    });
+  }
 }
 
 module.exports = API;

lib/steam/Resolve.js

 const fetch = require('node-fetch');
-const API = require('./API');
+const { parse } = require('url');
 
-class Resolve extends API {
+class Resolve {
   resolve(info) {
     if (!info) throw new Error('no info provided');
-    return new Promise(async (resolve, reject) => {
-        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');
-                }
-            }
+    return new Promise(async(resolve, reject) => {
+      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(`https://api.steampowered.com/ISteamUser/ResolveVanityURL/v1?key=${this.key}&vanityurl=${steamURL}`, this.headers)
-                .then(res => res.json())
-                .then(json => json.response.success === 1 ? json.response.steamid : reject('Invalid profile link/id'))
-                .catch(reject);
-        }
-        resolve(steamID);
+      }
+      if (steamURL) {
+        steamID = await fetch(`${this.baseURL}/ISteamUser/ResolveVanityURL/v1?key=${this.key}&vanityurl=${steamURL}`, this.headers)
+          .then(res => res.json())
+          .then(json => json.response.success === 1 ? json.response.steamid : reject('Invalid profile link/id'))
+          .catch(reject);
+      }
+      resolve(steamID);
     });
@@ -34,0 +33,0 @@ }

package.json

@@ -5,3 +5,3 @@ {
   "main": "lib/app.js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": [
@@ -8,0 +8,0 @@ "steam",

README.md

@@ -60,2 +60,3 @@ ## SteamAPI
 ### Methods
+- get
 - resolve
@@ -71,2 +72,2 @@ - getGameAchievements
 - getUserStats
-- getUserSummary
+- getUserSummary

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19073

increased by34.58%

Lines of code

362

increased by58.77%

Number of lines in readme file

72

increased by2.86%

Worsened metrics

Number of package files

9

decreased by-47.06%

Number of medium supply chain risk alerts

24

increased by118.18%

No dependency changes