steamutils 1.5.40 → 1.5.41

package/_steamproto.js

@@ -13,7 +13,7 @@ export class SteamProto {
 
   toProto() {
     const filePath = path.join(`${__dirname}/protos/`, this._proto.filename);
-    const root = new Protobuf.Root().loadSync([gpf.getProtoPath("google/protobuf/descriptor.proto"), filePath], {
+    const root = new Protobuf.Root().loadSync([gpf.getProtoPath("protobuf/descriptor.proto"), filePath], {
       keepCase: true,
     });
     return root.lookupType(this._proto.name);

package/index.js

@@ -4496,20 +4496,48 @@ export default class SteamUser {
     return await SteamUser.resolveUsers(steamIDs, this.getCookies());
   }
 
-  static async resolveUsers(steamIDs = [], cookie) {
+  /**
+   * @typedef {Object} SteamUserProfile
+   * @property {string} steamId - The user's 64-bit SteamID.
+   * @property {number} accountId - The user's numeric account ID.
+   * @property {string} name - The Steam persona name.
+   * @property {string} realName - The user's real name (may be empty).
+   * @property {string} avatarHash - The user's avatar hash or identifier.
+   * @property {string} customURL - The user's custom profile URL (may be empty).
+   * @property {number} personaState - The user's online status/state.
+   * @property {string} city - The user's city (may be empty).
+   * @property {string} state - The user's state/region (may be empty).
+   * @property {string} country - The user's country code (may be empty).
+   * @property {boolean} isFriend - Whether the user is a friend.
+   * @property {number} friendsInCommon - Number of mutual friends.
+   */
+
+  /**
+   * Resolves an array of Steam user IDs to their profile information using the Steam Community API.
+   *
+   * @param {(string|number)[]} steamIds - Array of Steam IDs (each a string or number).
+   * @param {string} [cookie] - Optional session cookie for Steam authentication.
+   * @returns {Promise<SteamUserProfile[]>} Promise resolving to an array of Steam user profile objects.
+   *
+   * @example
+   * const users = await SteamUser.resolveUsers(['76561199409201417']);
+   */
+  static async resolveUsers(steamIds, cookie) {
     //steamIDs max = 200
-    if (typeof steamIDs === "string") {
-      steamIDs = [steamIDs];
+
+    if (!Array.isArray(steamIds) || !steamIds.every((id) => typeof id === "string" || typeof id === "number")) {
+      console.error("steamIds must be an array of string or number.");
+      return [];
     }
 
-    steamIDs = _.uniq(steamIDs);
+    steamIds = _.uniq(steamIds);
 
-    if (steamIDs.length > 200) {
-      return _.flatten(await Promise.all(_.chunk(steamIDs, 200).map((_steamIDs) => SteamUser.resolveUsers(_steamIDs, cookie))));
+    if (steamIds.length > 200) {
+      return _.flatten(await Promise.all(_.chunk(steamIds, 200).map((_steamIds) => SteamUser.resolveUsers(_steamIds, cookie))));
     }
 
     const { data } = await request({
-      url: `https://steamcommunity.com/actions/ajaxresolveusers?steamids=${steamIDs.join(",")}`,
+      url: `https://steamcommunity.com/actions/ajaxresolveusers?steamids=${steamIds.join(",")}`,
       headers: { ...(cookie && { cookie }) },
     });
 
@@ -4520,21 +4548,43 @@ export default class SteamUser {
     return data.map(function (player) {
       return {
         steamId: player.steamid,
-        accountid: player.accountid,
+        accountId: player.accountid,
         name: player.persona_name,
-        realname: player.real_name,
+        realName: player.real_name,
         avatarHash: player.avatar_url,
         customURL: player.profile_url,
-        persona_state: player.persona_state,
+        personaState: player.persona_state,
         city: player.city,
         state: player.state,
         country: player.country,
-        is_friend: player.is_friend,
-        friends_in_common: player.friends_in_common,
+        isFriend: player.is_friend,
+        friendsInCommon: player.friends_in_common,
       };
     });
   }
 
+  /**
+   * Resolves a single Steam user ID to its profile information using the Steam Community API.
+   *
+   * @param {string|number} steamId - The Steam ID to resolve.
+   * @param {string} [cookie] - Optional session cookie for Steam authentication.
+   * @returns {Promise<SteamUserProfile|undefined>} Resolves to a user profile object, or undefined if not found or if input is invalid.
+   *
+   * @example
+   * const user = await SteamUser.resolveUser('76561199409201417');
+   * if (user) {
+   *   console.log(user.name);
+   * }
+   */
+  static async resolveUser(steamId, cookie) {
+    if (typeof steamId !== "string" && typeof steamId !== "number") {
+      console.error("resolveUser: steamId must be a string or number. Received:", steamId);
+      return;
+    }
+    const users = await this.resolveUsers([steamId], cookie);
+    return users[0];
+  }
+
   static GetAvatarURLFromHash(hash, size) {
     if (!hash) {
       return;
@@ -4658,10 +4708,25 @@ export default class SteamUser {
     return list;
   }
 
+  /**
+   * Retrieves the current Steam Guard status for the account.
+   *
+   * Makes an HTTP request to the Steam two-factor management page,
+   * parses the response, and determines the type of Steam Guard authentication enabled:
+   *   - "steam_authenticator" (mobile authenticator is enabled)
+   *   - "email_authenticator" (email confirmation is enabled)
+   *   - "none_authenticator" (no two-factor is enabled)
+   *
+   * If the request fails (ResponseError), returns null.
+   *
+   * @async
+   * @returns {Promise<"steam_authenticator"|"email_authenticator"|"none_authenticator"|null>}
+   *          A string representing the authenticator type, or null if the request fails.
+   */
   async getSteamGuardStatus() {
     const result = await this._httpRequest(`https://store.steampowered.com/twofactor/manage_action`);
     if (result instanceof ResponseError) {
-      return result;
+      return nuill;
     }
     const $ = cheerio.load(result?.data || "");
 
@@ -4678,7 +4743,20 @@ export default class SteamUser {
     }
   }
 
-  async turningSteamGuardOff() {
+  /**
+   * Attempts to initiate the process of turning Steam Guard off for the account.
+   *
+   * Sends a POST request to Steam's two-factor management endpoint to request the
+   * removal of Steam Guard. It then checks the response to verify whether the request
+   * to turn Steam Guard off was successfully triggered (an email confirmation is sent).
+   *
+   * @async
+   * @returns {Promise<boolean>}
+   *   Returns `true` if turning Steam Guard off requires email confirmation and the
+   *   corresponding message is found in the response;
+   *   returns `false` if an error occurs (e.g., a ResponseError is returned).
+   */
+  async requestSteamGuardDeactivation() {
     const result = await this._httpRequest({
       url: `https://store.steampowered.com/twofactor/manage_action`,
       headers: {
@@ -4692,13 +4770,25 @@ export default class SteamUser {
       method: "POST",
     });
     if (result instanceof ResponseError) {
-      return result;
+      return false;
     }
     const $ = cheerio.load(result?.data || "");
     return $("title").text() === `Steam Guard Mobile Authenticator` && !!result?.data?.includes?.(`Turning Steam Guard off requires confirmation. We've sent you an email with a link to confirm disabling Steam Guard.`);
   }
 
-  async turningEmailAuthenticatorCheckOn() {
+  /**
+   * Activates the email-based Steam Guard authenticator for the account.
+   *
+   * Sends a POST request to Steam's two-factor management endpoint to enable email-based authentication.
+   * Returns `true` if the response confirms that the email authenticator is enabled,
+   * or `false` if the request fails or the response does not indicate successful activation.
+   *
+   * @async
+   * @returns {Promise<boolean>}
+   *   Returns `true` if the email authenticator is activated successfully,
+   *   or `false` otherwise.
+   */
+  async activateEmailSteamGuard() {
     const result = await this._httpRequest({
       url: `https://store.steampowered.com/twofactor/manage_action`,
       headers: {
@@ -4713,19 +4803,31 @@ export default class SteamUser {
       method: "POST",
     });
     if (result instanceof ResponseError) {
-      return result;
+      return false;
     }
     const $ = cheerio.load(result?.data || "");
     return $("title").text() === `Steam Guard Mobile Authenticator` && $("#email_authenticator_check")?.attr("checked") == "checked";
   }
 
-  async getPhoneManage() {
-    //Ends in 17
+  /**
+   * Retrieves the current phone number status associated with the Steam account.
+   *
+   * Performs an HTTP request to the Steam phone management page and parses the response to
+   * determine if a phone number is bound to the account.
+   * - Returns `'none'` if no phone number is linked.
+   * - Returns a string describing the phone (e.g., 'Ends in 17') if one is bound.
+   * - Returns `null` on request failure or unexpected page content.
+   *
+   * @async
+   * @returns {Promise<string|null>}
+   *   The phone number status: `'none'`, a phone description string (like 'Ends in 17'), or `null` if the request fails.
+   */
+  async getPhoneNumberStatus() {
     const result = await this._httpRequest({
       url: `https://store.steampowered.com/phone/manage`,
     });
     if (result instanceof ResponseError) {
-      return result;
+      return null;
     }
     const $ = cheerio.load(result?.data || "");
     const pageheader = $("h2.pageheader").text();
@@ -4733,7 +4835,7 @@ export default class SteamUser {
       case "Add a phone number to your account":
         return "none";
       case "Manage phone number":
-        return $(".phone_header_description > span").text(); //Ends in 17}
+        return $(".phone_header_description > span").text(); //Example: Ends in 17
     }
   }
 

package/package.json

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