steamutils 1.5.51 → 1.5.53

package/full_steamproto.js

@@ -1,6 +1,7 @@
 import path from "path";
 import { fileURLToPath } from "url";
 import Protobuf from "protobufjs";
+import gpf from "google-proto-files";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -11,10 +12,14 @@ export class SteamProto {
   }
 
   toProto() {
-    const root = new Protobuf.Root().loadSync(path.join(`${__dirname}/protos/`, this._proto.filename), {
+    const localProto = path.join(`${__dirname}/protos/`, this._proto.filename);
+
+    const descriptorPath = gpf.getProtoPath("protobuf/descriptor.proto");
+
+    const root = new Protobuf.Root().loadSync([descriptorPath, localProto], {
       keepCase: true,
     });
-    return root[this._proto.name];
+    return root.lookupType(this._proto.name);
   }
 
   protoEncode(obj) {

package/index.js

@@ -5,7 +5,7 @@ import moment from "moment";
 import { hex2b64, Key as RSA } from "node-bignumber";
 import SteamID from "steamid";
 import qs from "qs";
-import { console_log, convertLongsToNumbers, downloadImage, formatMarketCurrency, formatMarketHistoryDate, getCleanObject, getImageSize, getMarketPriceValueAsInt, isJWT, JSON_parse, JSON_stringify, removeSpaceKeys, secretAsBuffer, sleep } from "./utils.js";
+import { console_log, convertLongsToNumbers, downloadImage, getCleanObject, getImageSize, isJWT, JSON_parse, JSON_stringify, removeSpaceKeys, secretAsBuffer, sleep } from "./utils.js";
 import { Header, request } from "./axios.js";
 import { getTableHasHeaders, querySelectorAll, table2json } from "./cheerio.js";
 import { getJSObjectFronXML } from "./xml2json.js";
@@ -21,7 +21,7 @@ import { AppID_CSGO, E1GameBanOnRecord, E1VACBanOnRecord, EActivityType, ECommen
 import SteamTotp from "steam-totp";
 import { SteamProto, SteamProtoType } from "./steamproto.js";
 import EventEmitter from "node:events";
-import { extractAssetItemsFromHovers, parseMarketHistoryListings, parseMarketListings } from "./parse_html.js";
+import { extractAssetItemsFromHovers, parseMarketHistoryListings, parseMarketListings, parseSteamProfileXmlToJson, parseUserProfile } from "./parse_html.js";
 
 const eventEmitter = (globalThis.steamUserEventEmitter = new EventEmitter());
 
@@ -397,8 +397,9 @@ export default class SteamUser {
 
     const result = await this._httpRequest(url);
     if (result instanceof ResponseError) {
-      return result;
+      return null;
     }
+
     return SteamUser._parseUserProfile(result?.data || "");
   }
 
@@ -537,6 +538,32 @@ export default class SteamUser {
     };
   }
 
+  /**
+   * Fetches a Steam Community profile (in XML format) by SteamID, parses it,
+   * and returns a normalized JSON representation.
+   *
+   * @async
+   * @param {string} [steamId] - 64-bit SteamID. Defaults to the result of `this.getSteamIdUser()`.
+   * @returns {Promise<SteamProfileXml|undefined>} Promise resolving to the normalized Steam profile object, or `undefined` on failure.
+   *
+   */
+  async getProfileFromXml(steamId = this.getSteamIdUser()) {
+    const result = await this._httpRequest(`https://steamcommunity.com/profiles/${steamId}/?xml=1`);
+    if (result instanceof ResponseError) {
+      return;
+    }
+    try {
+      return parseSteamProfileXmlToJson(result?.data);
+    } catch (e) {}
+  }
+
+  static async getProfileFromXml(steamId) {
+    try {
+      const xml = (await axios.get(`https://steamcommunity.com/profiles/${steamId}/?xml=1`)).data;
+      return parseSteamProfileXmlToJson(xml);
+    } catch (e) {}
+  }
+
   static async getUsersSummaryByWebApiKey(webApiKey, steamIds) {
     if (!Array.isArray(steamIds)) {
       steamIds = [steamIds];
@@ -7291,6 +7318,39 @@ export default class SteamUser {
     };
   }
 
+  /**
+   * @typedef {Object} FriendGameplayInfoEntry
+   * @property {string} steamId - The SteamID64 of the friend.
+   * @property {number} minutes_played - Number of minutes played recently or currently.
+   * @property {number} minutes_played_forever - Total minutes this friend has played forever.
+   */
+
+  /**
+   * @typedef {Object} YourInfo
+   * @property {number} minutes_played - Number of minutes you have played recently or currently.
+   * @property {number} minutes_played_forever - Total minutes you have played forever.
+   * @property {boolean} in_wishlist - Whether the app is in your wishlist.
+   * @property {boolean} owned - Whether you own the app.
+   */
+
+  /**
+   * @typedef {Object} FriendsGameplayInfoResponse
+   * @property {FriendGameplayInfoEntry[]} in_game - Friends currently playing the game.
+   * @property {FriendGameplayInfoEntry[]} played_recently - Friends who played the game recently.
+   * @property {FriendGameplayInfoEntry[]} played_ever - Friends who have ever played the game.
+   * @property {FriendGameplayInfoEntry[]} owns - Friends who own the game.
+   * @property {YourInfo} your_info - Information about your own playtime, wishlist and ownership for this app.
+   */
+
+  /**
+   * Retrieves Steam friends' gameplay stats for a specific app.
+   *
+   * @param {string} accessToken - Steam user access token.
+   * @param {number|string} appId - The App ID of the game to query.
+   * @returns {Promise<FriendsGameplayInfoResponse|undefined>}
+   *          Resolves with gameplay info: lists of friends (by status) and your stats for the app,
+   *          or `undefined` if the result is empty or on unauthorized access.
+   */
   async getFriendsGameplayInfo(accessToken, appId) {
     if (!appId) {
       return;
@@ -7311,7 +7371,7 @@ export default class SteamUser {
       responseType: "arraybuffer",
     });
     if (result instanceof ResponseError) {
-      return result;
+      return;
     }
 
     if (!result || result.status === 401) {
@@ -7339,45 +7399,6 @@ export default class SteamUser {
       owns: formatList(owns),
       your_info: _.omit(your_info, "steamid"),
     };
-
-    const example = [
-      {
-        public_data: {
-          visibility_state: 3,
-          privacy_state: 0,
-          profile_state: 1,
-          ban_expires_time: 0,
-          account_flags: 0,
-          persona_name: "LOL haha",
-          profile_url: "",
-          content_country_restricted: false,
-          steamId: "76561199243542939",
-          avatarHash: "0000000000000000000000000000000000000000",
-        },
-        private_data: {
-          persona_state: 0,
-          persona_state_flags: 0,
-          time_created: 1644675779,
-          game_id: 0,
-          game_server_ip_address: 0,
-          game_server_port: 0,
-          game_extra_info: "",
-          account_name: "",
-          lobby_steam_id: 0,
-          rich_presence_kv: "",
-          watching_broadcast_accountid: 0,
-          watching_broadcast_appid: 0,
-          watching_broadcast_viewers: 0,
-          watching_broadcast_title: "",
-          last_logoff_time: 0,
-          last_seen_online: 0,
-          game_os_type: 0,
-          game_device_type: 0,
-          game_device_name: "",
-          game_is_private: false,
-        },
-      },
-    ];
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "steamutils",
-  "version": "1.5.51",
+  "version": "1.5.53",
   "main": "index.js",
   "dependencies": {
     "alpha-common-utils": "^1.0.6",

package/parse_html.js

@@ -1,6 +1,7 @@
 import { StringUtils } from "alpha-common-utils/index.js";
-import { formatMarketHistoryDate } from "./utils.js";
+import { formatMarketHistoryDate, getAvatarHashFromUrl } from "./utils.js";
 import * as cheerio from "cheerio";
+import { getJSObjectFronXML } from "./xml2json.js";
 
 /**
  * @typedef {Object} HoverItem
@@ -187,3 +188,149 @@ export function parseMarketListings(html) {
 
   return results;
 }
+
+/**
+ * Represents a Steam Community group for a profile.
+ * @typedef {Object} SteamProfileGroupXml
+ * @property {string} groupID64
+ * @property {string} groupName
+ * @property {string} groupURL
+ * @property {string} headline
+ * @property {string} summary
+ * @property {string} avatarIcon
+ * @property {string} avatarMedium
+ * @property {string} avatarFull
+ * @property {number} memberCount
+ * @property {number} membersInChat
+ * @property {number} membersInGame
+ * @property {number} membersOnline
+ */
+
+/**
+ * Array of Steam Community groups.
+ * @typedef {SteamProfileGroupXml[]} SteamProfileGroupsXml
+ */
+
+/**
+ * Represents a most played game on a Steam profile.
+ * @typedef {Object} SteamProfileMostPlayedGameXml
+ * @property {string} gameName
+ * @property {string} gameLink
+ * @property {string} gameIcon
+ * @property {string} gameLogo
+ * @property {string} gameLogoSmall
+ * @property {number} hoursPlayed
+ * @property {number} hoursOnRecord
+ * @property {string} statsName
+ */
+
+/**
+ * Array of most played games.
+ * @typedef {SteamProfileMostPlayedGameXml[]} SteamProfileMostPlayedGamesXml
+ */
+
+/**
+ * Steam Community profile (parsed from XML, normalized).
+ * @typedef {Object} SteamProfileXml
+ * @property {string} name
+ * @property {string} steamId
+ * @property {string} onlineState
+ * @property {string} stateMessage
+ * @property {string} privacyState
+ * @property {number} visibilityState
+ * @property {string} avatarIcon
+ * @property {string} avatarMedium
+ * @property {string} avatarFull
+ * @property {string} avatarHash
+ * @property {number} vacBanned
+ * @property {string} tradeBanState
+ * @property {number} isLimitedAccount
+ * @property {string} customURL
+ * @property {string} memberSince
+ * @property {string} steamRating
+ * @property {number} hoursPlayed2Wk
+ * @property {string} headline
+ * @property {string} location
+ * @property {string} realname
+ * @property {string} summary
+ * @property {SteamProfileMostPlayedGamesXml} [mostPlayedGames]
+ * @property {SteamProfileGroupsXml} [groups]
+ */
+
+/**
+ * Parses a Steam profile XML into a normalized JSON format.
+ *
+ * @param {string} xml - The XML string as returned by the Steam Community profile endpoint.
+ * @returns {SteamProfileXml|undefined} The normalized profile object or undefined on error.
+ *
+ * @example
+ * import { parseSteamProfileXmlToJson } from "./your-module";
+ * const xml = await fetch('https://steamcommunity.com/profiles/76561198386265483/?xml=1').then(r => r.text());
+ * const profile = parseSteamProfileXmlToJson(xml);
+ * console.log(profile.name);
+ */
+export function parseSteamProfileXmlToJson(xml) {
+  const parsed = getJSObjectFronXML(xml);
+  if (!parsed || !parsed.profile) return;
+
+  // Flatten out the xml2js _structure, for direct children
+  const profile = {};
+  Object.entries(parsed.profile).forEach(([key, value]) => {
+    // If only text, keep as string
+    if (typeof value === "object" && value !== null && "_" in value && Object.keys(value).length === 1) {
+      profile[key] = value._;
+    } else {
+      profile[key] = value;
+    }
+  });
+
+  // Rename fields
+  if ("steamID" in profile) {
+    profile.name = profile.steamID;
+    delete profile.steamID;
+  }
+  if ("steamID64" in profile) {
+    profile.steamId = profile.steamID64;
+    delete profile.steamID64;
+  }
+
+  // Convert numbers
+  const numberFields = ["vacBanned", "isLimitedAccount", "visibilityState", "memberCount", "membersInChat", "membersInGame", "membersOnline", "hoursOnRecord"];
+  const floatFields = ["hoursPlayed2Wk", "hoursPlayed"];
+  for (const field of numberFields) {
+    if (field in profile) profile[field] = parseInt(profile[field], 10) || 0;
+  }
+  for (const field of floatFields) {
+    if (field in profile) profile[field] = parseFloat(profile[field]) || 0;
+  }
+
+  // Add avatarHash
+  const avatarUrl = profile.avatarFull || profile.avatarMedium || profile.avatarIcon;
+  profile.avatarHash = getAvatarHashFromUrl(avatarUrl);
+
+  // Ensure all simple fields are strings if empty object
+  for (const key in profile) {
+    if (typeof profile[key] === "object" && profile[key] !== null && Object.keys(profile[key]).length === 0) {
+      profile[key] = "";
+    }
+  }
+
+  // Move groups.group to top-level 'groups' if present
+  if (profile.groups && profile.groups.group) {
+    profile.groups = profile.groups.group;
+  }
+
+  // Remove _attributes from groups (if present)
+  if (Array.isArray(profile.groups)) {
+    profile.groups = profile.groups.map((group) => {
+      if (group && typeof group === "object" && "_attributes" in group) {
+        // shallow clone and remove _attributes
+        const { _attributes, ...groupWithoutAttributes } = group;
+        return groupWithoutAttributes;
+      }
+      return group;
+    });
+  }
+
+  return profile;
+}