steamutils 1.5.43 → 1.5.44

package/_steamproto.js

@@ -1,56 +1,56 @@
-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);
-
-export class SteamProto {
-  constructor(proto) {
-    this._proto = proto;
-  }
-
-  toProto() {
-    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.lookupType(this._proto.name);
-  }
-
-  protoEncode(obj) {
-    const protobuf = this.toProto();
-    return protobuf.encode(protobuf.create(obj)).finish();
-  }
-
-  protoEncodeBase64(obj) {
-    return this.protoEncode(obj).toString("base64");
-  }
-
-  protoDecode(obj) {
-    if (isBase64(obj)) {
-      obj = Buffer.from(obj, "base64");
-    }
-
-    const protobuf = this.toProto();
-    try {
-      return protobuf.toObject(protobuf.decode(obj), { defaults: true });
-    } catch (e) {
-      console.error(`[${this._proto.name}] protoDecode 1`, typeof obj, obj);
-      console.error(`[${this._proto.name}] protoDecode 2`, e);
-      return null;
-    }
-  }
-}
-
-function isBase64(str) {
-  if (typeof str !== "string") return false;
-  // remove whitespace and check
-  str = str.trim();
-  // base64 should only contain A-Z, a-z, 0-9, +, /, and possibly = at the end
-  return /^[A-Za-z0-9+/]+={0,2}$/.test(str) && str.length % 4 === 0;
-}
+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);
+
+export class SteamProto {
+  constructor(proto) {
+    this._proto = proto;
+  }
+
+  toProto() {
+    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.lookupType(this._proto.name);
+  }
+
+  protoEncode(obj) {
+    const protobuf = this.toProto();
+    return protobuf.encode(protobuf.create(obj)).finish();
+  }
+
+  protoEncodeBase64(obj) {
+    return this.protoEncode(obj).toString("base64");
+  }
+
+  protoDecode(obj) {
+    if (isBase64(obj)) {
+      obj = Buffer.from(obj, "base64");
+    }
+
+    const protobuf = this.toProto();
+    try {
+      return protobuf.toObject(protobuf.decode(obj), { defaults: true });
+    } catch (e) {
+      console.error(`[${this._proto.name}] protoDecode 1`, typeof obj, obj);
+      console.error(`[${this._proto.name}] protoDecode 2`, e);
+      return null;
+    }
+  }
+}
+
+function isBase64(str) {
+  if (typeof str !== "string") return false;
+  // remove whitespace and check
+  str = str.trim();
+  // base64 should only contain A-Z, a-z, 0-9, +, /, and possibly = at the end
+  return /^[A-Za-z0-9+/]+={0,2}$/.test(str) && str.length % 4 === 0;
+}

package/full_steamproto.js

@@ -1,7 +1,6 @@
 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);
@@ -12,14 +11,10 @@ export class SteamProto {
   }
 
   toProto() {
-    const localProto = path.join(`${__dirname}/protos/`, this._proto.filename);
-
-    const descriptorPath = gpf.getProtoPath("protobuf/descriptor.proto");
-
-    const root = new Protobuf.Root().loadSync([descriptorPath, localProto], {
+    const root = new Protobuf.Root().loadSync(path.join(`${__dirname}/protos/`, this._proto.filename), {
       keepCase: true,
     });
-    return root.lookupType(this._proto.name);
+    return root[this._proto.name];
   }
 
   protoEncode(obj) {

package/index.js

@@ -21,6 +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";
 
 const eventEmitter = (globalThis.steamUserEventEmitter = new EventEmitter());
 
@@ -6299,43 +6300,77 @@ export default class SteamUser {
       return null;
     }
 
-    const $ = cheerio.load(data.results_html);
-    const list = [];
-    $(".market_listing_row").each(function () {
-      try {
-        const $row = $(this);
-        const [sElementPrefix, listingid, appid, contextid, itemid] = $row
-          .find(".market_listing_cancel_button > a")
-          .attr("href")
-          .split("(")[1]
-          .split(")")[0]
-          .split(",")
-          .map((r) => r.trim().replaceAll(`'`, "").replaceAll(`"`, ""));
-        const image = $row.find(`#mylisting_${listingid}_image`).attr("src");
-        const buyer_pays_price = StringUtils.cleanSpace($row.find(`.market_listing_price span[title="This is the price the buyer pays."]`).text().replaceAll(`(`, "").replaceAll(`)`, ""));
-        const receive_price = StringUtils.cleanSpace($row.find(`.market_listing_price span[title="This is how much you will receive."]`).text().replaceAll(`(`, "").replaceAll(`)`, ""));
-        const item_name = $row.find(".market_listing_item_name_link").text() || $row.find(".market_listing_item_name").text();
-        const game_name = $row.find(".market_listing_game_name").text();
-        const date_combined = formatMarketHistoryDate(StringUtils.cleanSpace($row.find(".market_listing_game_name + .market_listing_listed_date_combined").text()));
-        list.push({
-          listingid,
-          appid,
-          contextid,
-          itemid,
-          buyer_pays_price,
-          receive_price,
-          item_name,
-          game_name,
-          date_combined,
-          image,
-        });
-      } catch (e) {}
-    });
+    const list = parseMarketListings(data.results_html);
     const assets = Object.values(data.assets["730"]?.["2"] || {});
     return { list, assets, success: true };
   }
 
-  async getMyMarketHistory({ start = 0, count = 100 } = {}) {
+  /**
+   * @typedef {Object} MarketHistoryResponse
+   * @property {boolean} success                     Whether the request was successful.
+   * @property {number} pagesize                     Number of items per page.
+   * @property {number} total_count                  Total count of market entries available.
+   * @property {number} start                        Starting index of the results.
+   * @property {Array<Asset>} assets                 Related inventory assets for the transactions.
+   * @property {string} hovers                       Raw JavaScript code for web asset hovers.
+   * @property {string} results_html                 Raw HTML snippet of market history.
+   * @property {Array<MarketHistoryListing>} list    Simplified, parsed list of market actions (buys/sells).
+   * // Optionally, you may add below for pre-parsed hover info
+   * // @property {Array<HoverItem>} [hoverItems]   Parsed item hover info (if extracted from hovers).
+   */
+
+  /**
+   * @typedef {Object} Asset
+   * @property {number} currency
+   * @property {number} appid
+   * @property {string} contextid
+   * @property {string} id
+   * @property {string} classid
+   * @property {string} instanceid
+   * @property {string} amount
+   * @property {number} status
+   * @property {string} original_amount
+   * @property {string} unowned_id
+   * @property {string} unowned_contextid
+   * @property {string} background_color
+   * @property {string} icon_url
+   * @property {Array<AssetDescription>} descriptions
+   * @property {number} tradable
+   * @property {Array<AssetAction>} [actions]
+   * @property {string} name
+   * @property {string} name_color
+   * @property {string} type
+   * @property {string} market_name
+   * @property {string} market_hash_name
+   * @property {Array<AssetAction>} [market_actions]
+   * @property {number} commodity
+   * @property {number} market_tradable_restriction
+   * @property {number} market_marketable_restriction
+   * @property {number} marketable
+   * @property {string} app_icon
+   * @property {number} owner
+   */
+
+  /**
+   * @typedef {Object} AssetDescription
+   * @property {string} type     Description style or block type (e.g. "html").
+   * @property {string} value    The description's content.
+   * @property {string} name     Field/tag name.
+   * @property {string} [color]  (Optional) Hex color string for this description entry.
+   */
+
+  /**
+   * @typedef {Object} AssetAction
+   * @property {string} link    URL or steam protocol link.
+   * @property {string} name    Action button text/description.
+   */
+
+  /**
+   * Retrieves the user's Steam Market transaction history, including assets, listing info, and hover selectors.
+   *
+   * @returns {MarketHistoryResponse} The market history data structure.
+   */
+  async getMarketHistory({ start = 0, count = 100 } = {}) {
     const result = await this._httpRequestAjax({
       url: `market/myhistory/render/?query=&start=${start}&count=${count}`,
     });
@@ -6349,56 +6384,10 @@ export default class SteamUser {
       return null;
     }
 
-    const hovers = StringUtils.cleanSpace(data.hovers);
+    const hovers = extractAssetItemsFromHovers(data.hovers);
     const assetById = data.assets?.[730]?.[2] || {};
-    const assestByListingId = {};
-    hovers.split("CreateItemHoverFromContainer").forEach(function (text) {
-      text = text.trim();
-      if (!text.startsWith("(")) {
-        return;
-      }
-      const texts = text.split(",");
-      const listingId = texts[1]?.substringBetweenOrNull("history_row_", "_");
-      const assestId = texts[4]?.trim()?.removeSurrounding("'");
-      if (!listingId || !assestId || !assetById[assestId]) {
-        return;
-      }
-      assestByListingId[listingId] = assestId;
-    });
-
-    const $ = cheerio.load(data.results_html);
-    const list = [...$(".market_listing_row")]
-      .map(function (el) {
-        el = $(el);
-        const id = el.attr("id");
-        const listingid = id.substringBetweenOrNull("history_row_", "_");
-        if (!listingid) {
-          return;
-        }
-        const gainOrLoss = StringUtils.cleanSpace(el.find(".market_listing_gainorloss").text());
-        const image = el.find(`.market_listing_item_img`).attr("src");
-        const price = parseInt(el.find(`.market_table_value .market_listing_price`).text().replaceAll(`(`, "").replaceAll(`)`, "").replaceAll(`₫`, "").replaceAll(`.`, "").replaceAll(`,`, "").trim()) || "";
-        const item_name = el.find(".market_listing_item_name").text();
-        const game_name = el.find(".market_listing_game_name").text();
-        const listedOn = formatMarketHistoryDate(StringUtils.cleanSpace(el.find(".market_listing_listed_date + .market_listing_listed_date").text().replaceAll(`Listed:`, "")));
-        const actedOn = formatMarketHistoryDate(StringUtils.cleanSpace(el.find(".market_listing_whoactedwith + .market_listing_listed_date").text().replaceAll(`Listed:`, "")));
-        const status = StringUtils.cleanSpace(el.find(".market_listing_whoactedwith").text());
-
-        return {
-          id,
-          listingid,
-          price,
-          item_name,
-          game_name,
-          listedOn,
-          actedOn,
-          image,
-          gainOrLoss,
-          status,
-          ...(!!assestByListingId[listingid] && { assetId: assestByListingId[listingid] }),
-        };
-      })
-      .filter(Boolean);
+    const assestByListingId = hovers.reduce((map, item) => (item.listingId && item.assetid && (map[item.listingId] = item.assetid), map), {});
+    const list = parseMarketHistoryListings(data.results_html, assestByListingId);
     const assets = Object.values(assetById);
     return { ...data, list, assets, success: true };
   }

package/package.json

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

package/parse_html.js

@@ -0,0 +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;
+}