simplesteamapis 0.0.4 → 1.0.1

package/README.md

@@ -1,96 +1,79 @@
-<h1 align="center">Welcome to SimpleSteamApis 👋</h1>
-<p>
-  <img alt="Version" src="https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000" />
-  <a href="#" target="_blank">
-    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
-  </a>
-</p>
+# SimpleSteamApis 👋
 
-> SteamApis.Com Package for easier use of the API
+[![Version](https://img.shields.io/badge/version-1.0.1-blue.svg?cacheSeconds=2592000)](#)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)
 
-### 🎉 [Project Home](http://steamapis.com)
+> A simple, zero-dependency Node.js wrapper for the [SteamApis.com](http://steamapis.com) API using native `fetch`.
 
-## Install
+&nbsp;
 
-```sh
-yarn add simplesteamapis
-```
+## 📋 Requirements:
+
+- Node.js **18+**
+- A [SteamApis.com](http://steamapis.com) API key
+
+&nbsp;
 
-or
+## 📦 Install:
+
+Use your preferred package manager:
 
 ```sh
-npm i simplesteamapis
+npm install simplesteamapis
+# or: yarn add simplesteamapis | pnpm add simplesteamapis | bun add simplesteamapis
 ```
 
-## Query Params
-
-<dl>
- <dt> getLegacyInventory(steamID, appID, contextID) </dt>
-   <dd> Used to get the legacy version of the users inventory. this includes some information that is not included in the new endpoints data.</dd>
- <dt>compactItems(appID)</dt>
-    <dd>Used to gather a compact version of the items from a specific game, provided an appID is provided, for example 730 (CSGO)</dd>
- <dt>CompactItemsWithValue(appID, compact_value)</dt>
-    <dd>Used to gather a compact version of the items from a specific game, like above. But with the added feature of allowing a user set timeframe for prices.</dd>
- </dl>
-
-
- <h2> Steam Specific </h2>
- <dl>
-  <dt>getInventory(steamID, appID, contextID)</dt>
-     <dd>Used to gather a users inventory from steam. If supplied with a steamID, appID and contextID, this is used in the example below.</dd>
-  <dt>getProfile(steamID)</dt>
-    <dd>Used to return all information regarding a steam users profile, such as name, avatar etc.</dd>
-  </dl>
-
-
- <h2>Market Specific</h2>
- <dl>
-  <dt>siteStats()</dt>
-    <dd>Used to return the stats of how many items have been scanned/requests that have been served by steamapis.com</dd>
-  <dt>app(appID)</dt>
-    <dd>Used to return all information on a specific game/application that has been chosen, 730 (CSGO) for example.</dd>
-  <dt>apps()</dt>
-    <dd>Used to return all information on all games tracked by steamapis.com.</dd>
-  <dt>item(appID, market_hash_name)</dt>
-    <dd>Used to return specific information for an item on the community market, provided an appID and Market name are provided.</dd>
-  <dt>items(appID)</dt>
-    <dd>Used to return all information on items for a specific game, that are on the community market. 730 (CSGO) for example.</dd>
-  <dt>cards()</dt>
-    <dd>used to return card data for all of steam.</dd>
-</dl>
-
- <h2>Image Specific</h2>
- <dl>
- <dt>itemsImage(appID)</dt>
-    <dd>returns images for items from a sepcific game or app, if appID is provided.</dd>
- </dl>   
-  
-## Usage
-
-Example:
+&nbsp;
 
-```sh
-const steamapis = require("simplesteamapis");
-const api = new steamapis("API_KEY");
-
-(async () => {
-  try {
-    const inventory = await api.getInventory("76561198027608071", 730, 2);
-    console.log(inventory);
-  } catch (err) {
-    console.log(err);
-  }
-})();
+## 🚀 Usage:
+
+```js
+const SteamApis = require("simplesteamapis");
+const api = new SteamApis("YOUR_API_KEY");
+
+// Fetch a user's CS:GO inventory
+const inventory = await api.getInventory("76561198027608071", 730, 2);
+
+// Look up a specific market item
+const item = await api.item(730, "AK-47 | Redline (Field-Tested)");
+
+// Get all tracked games
+const apps = await api.apps();
 ```
 
-## Author
+All methods are `async` and return parsed JSON. Errors throw with `err.message`, `err.status`, and `err.data` (the API's JSON error body) attached.
+
+&nbsp;
+
+## 📖 API Reference:
+
+### **Steam:**
+
+| Method                                          | Description                                                                     |
+| ----------------------------------------------- | ------------------------------------------------------------------------------- |
+| `getInventory(steamID, appID, contextID)`       | Fetches a user's Steam inventory for a given game and context.                  |
+| `getLegacyInventory(steamID, appID, contextID)` | Fetches a user's inventory in legacy format, which includes additional fields.  |
+| `getProfile(steamID)`                           | Fetches a user's Steam profile — display name, avatar, visibility, etc.        |
+
+&nbsp;
 
-👤 **Ashley Bridges**
+### **Market:**
 
-- Github: [@idefinehd](https://github.com/idefinehd)
+| Method                                       | Description                                                                        |
+| -------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `siteStats()`                                | Platform stats for SteamApis.com — items scanned, requests served, etc.           |
+| `app(appID)`                                 | Detailed information for a specific game or application.                           |
+| `apps()`                                     | Lists all games and applications currently tracked by SteamApis.com.               |
+| `item(appID, market_hash_name)`              | Pricing and metadata for a single item on the Steam Community Market.              |
+| `items(appID)`                               | All tracked market items for a given game.                                         |
+| `compactItems(appID)`                        | Compact market item list — equivalent to passing `format=compact` to the API.     |
+| `CompactItemsWithValue(appID, compact_value)`| Compact market item list with a custom timeframe for price values.                 |
+| `cards()`                                    | Trading card data across all games on Steam.                                       |
 
-## Show your support
+&nbsp;
 
-Give a ⭐️ if this project helped you!
+### **Images:**
 
----
+| Method              | Description                                          |
+| ------------------- | ---------------------------------------------------- |
+| `itemsImage(appID)` | Image URLs for all items within a given game.        |

package/examples/getInventory.js

@@ -1,11 +1,11 @@
-const steamapis = require("simplesteamapis");
-const api = new steamapis("API_KEY");
-
-(async () => {
-  try {
-    const inventory = await api.getInventory("76561198027608071", 730, 2);
-    console.log(inventory);
-  } catch (err) {
-    console.log(err);
-  }
-})();
+const steamapis = require("simplesteamapis");
+const api = new steamapis("API_KEY");
+
+(async () => {
+  try {
+    const inventory = await api.getInventory("76561198027608071", 730, 2);
+    console.log(inventory);
+  } catch (err) {
+    console.log(err);
+  }
+})();

package/examples/getItem.js

@@ -1,11 +1,11 @@
-const steamapis = require("simplesteamapis");
-const api = new steamapis("API_KEY"); // Put api key here
-
-(async () => {
-  try {
-    const inventory = await api.item(730, "AK-47 | Redline (Field-Tested)");
-    console.log(inventory);
-  } catch (err) {
-    console.log(err);
-  }
-})();
+const steamapis = require("simplesteamapis");
+const api = new steamapis("API_KEY"); // Put api key here
+
+(async () => {
+  try {
+    const inventory = await api.item(730, "AK-47 | Redline (Field-Tested)");
+    console.log(inventory);
+  } catch (err) {
+    console.log(err);
+  }
+})();

package/index.js

@@ -1,98 +1,114 @@
-const axios = require("axios");
-
-class steamapis {
-  constructor(api_key) {
-    this.api_key = api_key;
-  }
-
-  //Added (Optional Query Parameters) as different routes
-  async getLegacyInventory(steamID, appID, contextID) {
-    return this.baseRequestWithParameter(
-      `steam/inventory/${steamID}/${appID}/${contextID}`,
-      `legacy=1`
-    );
-  }
-
-  async compactItems(appID) {
-    return this.baseRequestWithParameter(
-      `market/items/${appID}`,
-      `format=compact`
-    );
-  }
-
-  async CompactItemsWithValue(appID, compact_value) {
-    return this.baseRequestWithParameter(
-      `market/items/${appID}`,
-      `format=compact&compact_value=${compact_value}`
-    );
-  }
-
-  // Seperated Endpoints for respective categories
-
-  //Steam Section
-
-  async getInventory(steamID, appID, contextID) {
-    return this.baseRequest(`steam/inventory/${steamID}/${appID}/${contextID}`);
-  }
-
-  async getProfile(steamID) {
-    return this.baseRequest(`steam/profile/${steamID}`);
-  }
-
-  // Market Endpoint
-
-  async siteStats() {
-    return this.baseRequest("market/stats");
-  }
-
-  async app(appID) {
-    return this.baseRequest(`market/app/${appID}`);
-  }
-
-  async apps() {
-    return this.baseRequest("market/apps");
-  }
-
-  async item(appID, market_hash_name) {
-    return this.baseRequest(`market/item/${appID}/${market_hash_name}`);
-  }
-
-  async items(appID) {
-    return this.baseRequest(`market/items/${appID}`);
-  }
-
-  async cards() {
-    return this.baseRequest("market/items/cards");
-  }
-
-  // Images
-  async itemsImage(appID) {
-    return this.baseRequest(`image/items/${appID}`);
-  }
-
-  //TODO: Add Extended optional requests to the endpoints
-
-  async baseRequest(endpoint) {
-    const res = await axios({
-      url: `http://api.steamapis.com/${endpoint}?api_key=${this.api_key}`,
-      method: "GET",
-      headers: {
-        "User-Agent": "STEAMAPIS NPM PACKAGE",
-      },
-    });
-    return res.data;
-  }
-
-  async baseRequestWithParameter(endpoint, QueryParameter) {
-    const res = await axios({
-      url: `http://api.steamapis.com/${endpoint}?api_key=${this.api_key}&${QueryParameter}`,
-      method: "GET",
-      headers: {
-        "User-Agent": "STEAMAPIS NPM PACKAGE",
-      },
-    });
-    return res.data;
-  }
-}
-
-module.exports = steamapis;
+class steamapis {
+  constructor(api_key) {
+    this.api_key = api_key;
+  }
+
+  //Added (Optional Query Parameters) as different routes
+  async getLegacyInventory(steamID, appID, contextID) {
+    return this.baseRequestWithParameter(
+      `steam/inventory/${steamID}/${appID}/${contextID}`,
+      `legacy=1`,
+    );
+  }
+
+  async compactItems(appID) {
+    return this.baseRequestWithParameter(
+      `market/items/${appID}`,
+      `format=compact`,
+    );
+  }
+
+  async CompactItemsWithValue(appID, compact_value) {
+    return this.baseRequestWithParameter(
+      `market/items/${appID}`,
+      `format=compact&compact_value=${compact_value}`,
+    );
+  }
+
+  // Seperated Endpoints for respective categories
+
+  //Steam Section
+
+  async getInventory(steamID, appID, contextID) {
+    return this.baseRequest(`steam/inventory/${steamID}/${appID}/${contextID}`);
+  }
+
+  async getProfile(steamID) {
+    return this.baseRequest(`steam/profile/${steamID}`);
+  }
+
+  // Market Endpoint
+
+  async siteStats() {
+    return this.baseRequest("market/stats");
+  }
+
+  async app(appID) {
+    return this.baseRequest(`market/app/${appID}`);
+  }
+
+  async apps() {
+    return this.baseRequest("market/apps");
+  }
+
+  async item(appID, market_hash_name) {
+    return this.baseRequest(`market/item/${appID}/${market_hash_name}`);
+  }
+
+  async items(appID) {
+    return this.baseRequest(`market/items/${appID}`);
+  }
+
+  async cards() {
+    return this.baseRequest("market/items/cards");
+  }
+
+  // Images
+  async itemsImage(appID) {
+    return this.baseRequest(`image/items/${appID}`);
+  }
+
+  //TODO: Add Extended optional requests to the endpoints
+
+  async baseRequest(endpoint) {
+    const res = await fetch(
+      `http://api.steamapis.com/${endpoint}?api_key=${this.api_key}`,
+      {
+        method: "GET",
+        headers: {
+          "User-Agent": "STEAMAPIS NPM PACKAGE",
+        },
+      },
+    );
+    if (!res.ok) {
+      const body = await res.json().catch(() => null);
+      const err = new Error(`Request failed with status ${res.status}`);
+      err.status = res.status;
+      err.data = body;
+      throw err;
+    }
+    return res.json();
+  }
+
+  async baseRequestWithParameter(endpoint, QueryParameter) {
+    const res = await fetch(
+      `http://api.steamapis.com/${endpoint}?api_key=${this.api_key}&${QueryParameter}`,
+      {
+        method: "GET",
+        headers: {
+          "User-Agent": "STEAMAPIS NPM PACKAGE",
+        },
+      },
+    );
+    if (!res.ok) {
+      const body = await res.json().catch(() => null);
+      const err = new Error(`Request failed with status ${res.status}`);
+      err.status = res.status;
+      err.data = body;
+      throw err;
+    }
+    return res.json();
+  }
+}
+
+module.exports = steamapis;

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "simplesteamapis",
-  "version": "0.0.4",
+  "version": "1.0.1",
   "description": "SteamApis.Com Package for easier use of the API",
   "main": "index.js",
   "directories": {
     "example": "examples"
   },
-  "dependencies": {
-    "axios": "^0.21.1"
-  },
+  "dependencies": {},
   "devDependencies": {},
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}