steamutils 1.5.51 → 1.5.52

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

@@ -7291,6 +7291,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 +7344,7 @@ export default class SteamUser {
       responseType: "arraybuffer",
     });
     if (result instanceof ResponseError) {
-      return result;
+      return;
     }
 
     if (!result || result.status === 401) {
@@ -7339,45 +7372,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.52",
   "main": "index.js",
   "dependencies": {
     "alpha-common-utils": "^1.0.6",

package/parse_html.js

@@ -1,189 +1,189 @@
-import { StringUtils } from "alpha-common-utils/index.js";
-import { formatMarketHistoryDate } from "./utils.js";
-import * as cheerio from "cheerio";
-
-/**
- * @typedef {Object} HoverItem
- * @property {string|null} listingId         The listing ID extracted from the selector, if available (as string).
- * @property {number} appid                  The app (game) ID for this item.
- * @property {number} contextid              The context ID for this item.
- * @property {number} assetid                The unique asset ID.
- * @property {string} unknown                A string field captured from the arguments (usually "0").
- * @property {string} [name_selector]        The HTML selector for the item's name, if present.
- * @property {string} [image_selector]       The HTML selector for the item's image, if present.
- * @property {string} [other_selector]       The selector string if it does not match name/image pattern.
- */
-
-/**
- * Extracts item information from Steam inventory trade history or similar HTML fragments.
- * Scans the given HTML string for calls to `CreateItemHoverFromContainer` and extracts
- * key data for each referenced item. Returns each item's info in a structured array.
- *
- * @param {string} html - The HTML string to parse.
- * @returns {HoverItem[]} Array of hover item objects.
- */
-export function extractAssetItemsFromHovers(html) {
-  // Use your preferred HTML/space scrubber.
-  html = StringUtils.cleanSpace(html);
-
-  // RegExp for CreateItemHoverFromContainer arguments
-  const re = /CreateItemHoverFromContainer\s*\(\s*g_rgAssets\s*,\s*'([^']+)'\s*,\s*(\d+)\s*,\s*'(\d+)'\s*,\s*'(\d+)'\s*,\s*(\d+)\s*\)/g;
-
-  /** @type {Record<number, HoverItem>} */
-  const itemsMap = {};
-  let match;
-
-  while ((match = re.exec(html)) !== null) {
-    const [_, selector, appid, contextid, assetid, unknown] = match;
-
-    // Extract listingId as a string if present: "history_row_<listingId>_"
-    let listingId = null;
-    const lidMatch = selector.match(/history_row_(\d+)_/);
-    if (lidMatch) listingId = lidMatch[1]; // assign as string
-
-    const appidNum = Number(appid);
-    const contextidNum = Number(contextid);
-    const assetidNum = Number(assetid);
-
-    if (!itemsMap[assetidNum]) {
-      itemsMap[assetidNum] = {
-        listingId,
-        appid: appidNum,
-        contextid: contextidNum,
-        assetid: assetidNum,
-        unknown,
-      };
-    }
-
-    if (selector.endsWith("_name")) {
-      itemsMap[assetidNum].name_selector = selector;
-    } else if (selector.endsWith("_image")) {
-      itemsMap[assetidNum].image_selector = selector;
-    } else {
-      itemsMap[assetidNum].other_selector = selector;
-    }
-  }
-  return Object.values(itemsMap);
-}
-
-/**
- * @typedef {Object} MarketHistoryListing
- * @property {string} id - HTML row id attribute (e.g. "history_row_4316182845737233773_4316182845737233774").
- * @property {string} listingId - Listing id (e.g. "4316182845737233773").
- * @property {number} price - Price in integer form (e.g. 80270).
- * @property {string} itemName - The market item's name (e.g. "UMP-45 | Mudder").
- * @property {string} gameName - The game's name (e.g. "Counter-Strike 2").
- * @property {string} listedOn - Listing date as string (e.g. "27 May 2024").
- * @property {string} actedOn - Acted on date or empty string.
- * @property {string} image - Full image URL for the item.
- * @property {string} gainOrLoss - "+" for buys, "-" for sells.
- * @property {string} status - Status text, usually empty string.
- * @property {string} [assetId] - (optional) Associated asset id, if available.
- */
-
-/**
- * Parses Steam market history listing rows into structured data objects.
- *
- * @param {string} html - The raw HTML string to parse.
- * @param {Object} [assetByListingId={}] - Optional mapping of listingId to assetId.
- * @returns {MarketHistoryListing[]} Array of market listing objects.
- */
-export function parseMarketHistoryListings(html, assetByListingId = {}) {
-  const $ = cheerio.load(html);
-  return $(".market_listing_row")
-    .toArray()
-    .map((el) => {
-      const $el = $(el);
-      const id = $el.attr("id");
-      const listingId = id?.match(/history_row_(.*?)_/)?.[1];
-      if (!listingId) return null;
-      const [gainOrLoss, image, priceText, itemName, gameName, listedOnText, actedOnText, status] = [$el.find(".market_listing_gainorloss").text().trim(), $el.find(".market_listing_item_img").attr("src"), $el.find(".market_table_value .market_listing_price").text(), $el.find(".market_listing_item_name").text().trim(), $el.find(".market_listing_game_name").text().trim(), $el.find(".market_listing_listed_date + .market_listing_listed_date").text(), $el.find(".market_listing_whoactedwith + .market_listing_listed_date").text(), $el.find(".market_listing_whoactedwith").text().trim()];
-      const price = parseInt(priceText.replace(/[₫().,]/g, "").trim(), 10) || "";
-      const listedOn = typeof formatMarketHistoryDate === "function" ? formatMarketHistoryDate(listedOnText.replace(/Listed:/, "").trim()) : listedOnText.replace(/Listed:/, "").trim();
-      const actedOn = typeof formatMarketHistoryDate === "function" ? formatMarketHistoryDate(actedOnText.replace(/Listed:/, "").trim()) : actedOnText.replace(/Listed:/, "").trim();
-
-      const result = {
-        id,
-        listingId,
-        price,
-        itemName,
-        gameName,
-        listedOn,
-        actedOn,
-        image,
-        gainOrLoss,
-        status,
-      };
-      if (assetByListingId?.[listingId]) result.assetId = assetByListingId[listingId];
-      return result;
-    })
-    .filter(Boolean);
-}
-
-/**
- * Parses Steam Market HTML listings to an array of items.
- *
- * @param {string} html - HTML string containing listing rows.
- * @returns {Array<{
- *   listingId: string,
- *   appId: number,
- *   contextId: number,
- *   itemId: number,
- *   imageUrl: string|null,
- *   buyerPaysPrice: string,
- *   receivePrice: string,
- *   itemName: string,
- *   gameName: string,
- *   listedDate: string
- * }>}
- */
-export function parseMarketListings(html) {
-  const $ = cheerio.load(html);
-  const results = [];
-
-  $(".market_listing_row").each((index, element) => {
-    const $row = $(element);
-
-    const cancelLink = $row.find(".market_listing_cancel_button > a").attr("href");
-    if (!cancelLink) return;
-
-    const paramsMatch = cancelLink.match(/\(([^)]*)\)/);
-    if (!paramsMatch) return;
-
-    let [, listingId, appId, contextId, itemId] = paramsMatch[1].split(",").map((param) => param.trim().replace(/^['"]|['"]$/g, ""));
-
-    appId = Number(appId);
-    contextId = Number(contextId);
-    itemId = Number(itemId);
-
-    const imageUrl = $row.find(`#mylisting_${listingId}_image`).attr("src") || null;
-
-    const buyerPaysElem = $row.find('.market_listing_price span[title="This is the price the buyer pays."]');
-    const buyerPaysPrice = StringUtils.cleanSpace(buyerPaysElem.text().replace(/[()]/g, ""));
-
-    const receiveElem = $row.find('.market_listing_price span[title="This is how much you will receive."]');
-    const receivePrice = StringUtils.cleanSpace(receiveElem.text().replace(/[()]/g, ""));
-
-    const itemName = $row.find(".market_listing_item_name_link").text() || $row.find(".market_listing_item_name").text();
-
-    const gameName = $row.find(".market_listing_game_name").text();
-
-    const listedDateElem = $row.find(".market_listing_game_name + .market_listing_listed_date_combined");
-    const listedDate = formatMarketHistoryDate(StringUtils.cleanSpace(listedDateElem.text()));
-
-    results.push({
-      listingId,
-      appId,
-      contextId,
-      itemId,
-      imageUrl,
-      buyerPaysPrice,
-      receivePrice,
-      itemName,
-      gameName,
-      listedDate,
-    });
-  });
-
-  return results;
-}
+import { StringUtils } from "alpha-common-utils/index.js";
+import { formatMarketHistoryDate } from "./utils.js";
+import * as cheerio from "cheerio";
+
+/**
+ * @typedef {Object} HoverItem
+ * @property {string|null} listingId         The listing ID extracted from the selector, if available (as string).
+ * @property {number} appid                  The app (game) ID for this item.
+ * @property {number} contextid              The context ID for this item.
+ * @property {number} assetid                The unique asset ID.
+ * @property {string} unknown                A string field captured from the arguments (usually "0").
+ * @property {string} [name_selector]        The HTML selector for the item's name, if present.
+ * @property {string} [image_selector]       The HTML selector for the item's image, if present.
+ * @property {string} [other_selector]       The selector string if it does not match name/image pattern.
+ */
+
+/**
+ * Extracts item information from Steam inventory trade history or similar HTML fragments.
+ * Scans the given HTML string for calls to `CreateItemHoverFromContainer` and extracts
+ * key data for each referenced item. Returns each item's info in a structured array.
+ *
+ * @param {string} html - The HTML string to parse.
+ * @returns {HoverItem[]} Array of hover item objects.
+ */
+export function extractAssetItemsFromHovers(html) {
+  // Use your preferred HTML/space scrubber.
+  html = StringUtils.cleanSpace(html);
+
+  // RegExp for CreateItemHoverFromContainer arguments
+  const re = /CreateItemHoverFromContainer\s*\(\s*g_rgAssets\s*,\s*'([^']+)'\s*,\s*(\d+)\s*,\s*'(\d+)'\s*,\s*'(\d+)'\s*,\s*(\d+)\s*\)/g;
+
+  /** @type {Record<number, HoverItem>} */
+  const itemsMap = {};
+  let match;
+
+  while ((match = re.exec(html)) !== null) {
+    const [_, selector, appid, contextid, assetid, unknown] = match;
+
+    // Extract listingId as a string if present: "history_row_<listingId>_"
+    let listingId = null;
+    const lidMatch = selector.match(/history_row_(\d+)_/);
+    if (lidMatch) listingId = lidMatch[1]; // assign as string
+
+    const appidNum = Number(appid);
+    const contextidNum = Number(contextid);
+    const assetidNum = Number(assetid);
+
+    if (!itemsMap[assetidNum]) {
+      itemsMap[assetidNum] = {
+        listingId,
+        appid: appidNum,
+        contextid: contextidNum,
+        assetid: assetidNum,
+        unknown,
+      };
+    }
+
+    if (selector.endsWith("_name")) {
+      itemsMap[assetidNum].name_selector = selector;
+    } else if (selector.endsWith("_image")) {
+      itemsMap[assetidNum].image_selector = selector;
+    } else {
+      itemsMap[assetidNum].other_selector = selector;
+    }
+  }
+  return Object.values(itemsMap);
+}
+
+/**
+ * @typedef {Object} MarketHistoryListing
+ * @property {string} id - HTML row id attribute (e.g. "history_row_4316182845737233773_4316182845737233774").
+ * @property {string} listingId - Listing id (e.g. "4316182845737233773").
+ * @property {number} price - Price in integer form (e.g. 80270).
+ * @property {string} itemName - The market item's name (e.g. "UMP-45 | Mudder").
+ * @property {string} gameName - The game's name (e.g. "Counter-Strike 2").
+ * @property {string} listedOn - Listing date as string (e.g. "27 May 2024").
+ * @property {string} actedOn - Acted on date or empty string.
+ * @property {string} image - Full image URL for the item.
+ * @property {string} gainOrLoss - "+" for buys, "-" for sells.
+ * @property {string} status - Status text, usually empty string.
+ * @property {string} [assetId] - (optional) Associated asset id, if available.
+ */
+
+/**
+ * Parses Steam market history listing rows into structured data objects.
+ *
+ * @param {string} html - The raw HTML string to parse.
+ * @param {Object} [assetByListingId={}] - Optional mapping of listingId to assetId.
+ * @returns {MarketHistoryListing[]} Array of market listing objects.
+ */
+export function parseMarketHistoryListings(html, assetByListingId = {}) {
+  const $ = cheerio.load(html);
+  return $(".market_listing_row")
+    .toArray()
+    .map((el) => {
+      const $el = $(el);
+      const id = $el.attr("id");
+      const listingId = id?.match(/history_row_(.*?)_/)?.[1];
+      if (!listingId) return null;
+      const [gainOrLoss, image, priceText, itemName, gameName, listedOnText, actedOnText, status] = [$el.find(".market_listing_gainorloss").text().trim(), $el.find(".market_listing_item_img").attr("src"), $el.find(".market_table_value .market_listing_price").text(), $el.find(".market_listing_item_name").text().trim(), $el.find(".market_listing_game_name").text().trim(), $el.find(".market_listing_listed_date + .market_listing_listed_date").text(), $el.find(".market_listing_whoactedwith + .market_listing_listed_date").text(), $el.find(".market_listing_whoactedwith").text().trim()];
+      const price = parseInt(priceText.replace(/[₫().,]/g, "").trim(), 10) || "";
+      const listedOn = typeof formatMarketHistoryDate === "function" ? formatMarketHistoryDate(listedOnText.replace(/Listed:/, "").trim()) : listedOnText.replace(/Listed:/, "").trim();
+      const actedOn = typeof formatMarketHistoryDate === "function" ? formatMarketHistoryDate(actedOnText.replace(/Listed:/, "").trim()) : actedOnText.replace(/Listed:/, "").trim();
+
+      const result = {
+        id,
+        listingId,
+        price,
+        itemName,
+        gameName,
+        listedOn,
+        actedOn,
+        image,
+        gainOrLoss,
+        status,
+      };
+      if (assetByListingId?.[listingId]) result.assetId = assetByListingId[listingId];
+      return result;
+    })
+    .filter(Boolean);
+}
+
+/**
+ * Parses Steam Market HTML listings to an array of items.
+ *
+ * @param {string} html - HTML string containing listing rows.
+ * @returns {Array<{
+ *   listingId: string,
+ *   appId: number,
+ *   contextId: number,
+ *   itemId: number,
+ *   imageUrl: string|null,
+ *   buyerPaysPrice: string,
+ *   receivePrice: string,
+ *   itemName: string,
+ *   gameName: string,
+ *   listedDate: string
+ * }>}
+ */
+export function parseMarketListings(html) {
+  const $ = cheerio.load(html);
+  const results = [];
+
+  $(".market_listing_row").each((index, element) => {
+    const $row = $(element);
+
+    const cancelLink = $row.find(".market_listing_cancel_button > a").attr("href");
+    if (!cancelLink) return;
+
+    const paramsMatch = cancelLink.match(/\(([^)]*)\)/);
+    if (!paramsMatch) return;
+
+    let [, listingId, appId, contextId, itemId] = paramsMatch[1].split(",").map((param) => param.trim().replace(/^['"]|['"]$/g, ""));
+
+    appId = Number(appId);
+    contextId = Number(contextId);
+    itemId = Number(itemId);
+
+    const imageUrl = $row.find(`#mylisting_${listingId}_image`).attr("src") || null;
+
+    const buyerPaysElem = $row.find('.market_listing_price span[title="This is the price the buyer pays."]');
+    const buyerPaysPrice = StringUtils.cleanSpace(buyerPaysElem.text().replace(/[()]/g, ""));
+
+    const receiveElem = $row.find('.market_listing_price span[title="This is how much you will receive."]');
+    const receivePrice = StringUtils.cleanSpace(receiveElem.text().replace(/[()]/g, ""));
+
+    const itemName = $row.find(".market_listing_item_name_link").text() || $row.find(".market_listing_item_name").text();
+
+    const gameName = $row.find(".market_listing_game_name").text();
+
+    const listedDateElem = $row.find(".market_listing_game_name + .market_listing_listed_date_combined");
+    const listedDate = formatMarketHistoryDate(StringUtils.cleanSpace(listedDateElem.text()));
+
+    results.push({
+      listingId,
+      appId,
+      contextId,
+      itemId,
+      imageUrl,
+      buyerPaysPrice,
+      receivePrice,
+      itemName,
+      gameName,
+      listedDate,
+    });
+  });
+
+  return results;
+}