@timmsy/riftjs 1.0.0 → 1.5.0

package/README.md

@@ -0,0 +1,152 @@
+# RiftJS
+
+A lightweight Node.js wrapper for the Riot Games API, providing easy access to League of Legends game data.
+
+[![npm version](https://badge.fury.io/js/@timmsy%2Friftjs.svg)](https://www.npmjs.com/package/@timmsy/riftjs)
+![GitHub license](https://img.shields.io/github/license/timmsy1998/RiftJS)
+
+## Overview
+
+RiftJS simplifies interaction with the Riot Games API and DataDragon static data. It supports fetching account details, summoner info, match history, and game data using a modular endpoint structure. Built with `axios` and `dotenv`, it’s designed for developers building League of Legends tools or applications.
+
+## Features
+
+- **RiotAPI**: Fetch account data by Riot ID, summoner data by PUUID, match history, and match details.
+- **DataDragon**: Access static game data like champions and items.
+- **Region Support**: Handles platform (e.g., `EUW1`) and shard (e.g., `europe`) routing.
+- **Modular Design**: Endpoints are organized in an `/endpoints/` directory for easy extension.
+
+## Installation
+
+Install RiftJS via npm:
+
+```
+npm install @timmsy/riftjs
+```
+
+You’ll also need a Riot Games API key from [developer.riotgames.com](https://developer.riotgames.com/).
+
+## Setup
+
+1. **Install Dependencies**:
+   Ensure you have Node.js installed, then run the install command above.
+
+2. **Configure Environment**:
+   Create a `.env` file in your project root with your API key and region:
+   ```
+   RIOT_API_KEY=RGAPI-your-api-key-here
+   REGION=EUW1
+   ```
+   - Replace `RGAPI-your-api-key-here` with your API key.
+   - Use a short region code (e.g., `EUW1`, `NA1`). See [Region Mapping](#region-mapping) for details.
+
+## Usage
+
+Here’s a basic example to get started:
+
+```
+const { RiotAPI, DataDragon } = require('@timmsy/riftjs');
+
+// Initialize RiotAPI
+const riot = new RiotAPI();
+
+// Fetch account, summoner, and match data
+async function fetchPlayerData() {
+  try {
+    const account = await riot.getAccountByRiotId('Timmsy#BRUV');
+    console.log('Account:', account);
+
+    const summoner = await riot.getSummonerByPuuid(account.puuid);
+    console.log('Summoner:', summoner);
+
+    const matchlist = await riot.getMatchlistByPuuid(account.puuid, { start: 0, count: 5 });
+    console.log('Matchlist:', matchlist);
+
+    const match = await riot.getMatchById(matchlist[0]);
+    console.log('Match:', match);
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+// Initialize DataDragon
+const dd = new DataDragon();
+
+async function fetchStaticData() {
+  try {
+    const champions = await dd.getChampions();
+    console.log('Champions:', champions.data);
+
+    const items = await dd.getItems();
+    console.log('Items:', items.data);
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+// Run the examples
+fetchPlayerData();
+fetchStaticData();
+```
+
+## API Reference
+
+### RiotAPI
+- `getAccountByRiotId(riotId, [tagLine], [region])`: Fetch account by Riot ID (e.g., `Timmsy#BRUV`).
+- `getSummonerByPuuid(puuid, [region])`: Get summoner data by PUUID.
+- `getMatchlistByPuuid(puuid, [options], [region])`: Get match history (options: `{ start, count }`).
+- `getMatchById(matchId, [region])`: Get match details.
+
+### DataDragon
+- `getChampions()`: Fetch all champion data.
+- `getItems()`: Fetch all item data.
+
+## Region Mapping
+
+RiftJS uses a region map to route requests correctly:
+- **Platform Routing** (e.g., Summoner V4):
+  - `EUW1` → `euw1.api.riotgames.com`
+  - `NA1` → `na1.api.riotgames.com`
+- **Shard Routing** (e.g., Account V1, Match V5):
+  - `EUW1` → `europe.api.riotgames.com`
+  - `NA1` → `americas.api.riotgames.com`
+
+Supported regions: `BR1`, `EUN1`, `EUW1`, `JP1`, `KR`, `LA1`, `LA2`, `NA1`, `OC1`, `TR1`, `RU`, `PH2`, `SG2`, `TH2`, `TW2`, `VN2`.
+
+## Keywords
+
+- riot-api
+- league-of-legends
+- lol-api
+- datadragon
+- summoner
+- match-history
+- game-data
+- node-js
+- javascript
+- api-wrapper
+
+## Development
+
+To contribute or run locally:
+1. Clone the repo:
+   ```
+   git clone https://github.com/timmsy1998/RiftJS.git
+   cd RiftJS
+   ```
+2. Install dependencies:
+   ```
+   npm install
+   ```
+3. Create a `.env` file (see [Setup](#setup)).
+4. Test with `node test.js` (requires a valid API key).
+
+## License
+
+MIT License © 2025 James Timms. See [LICENSE](LICENSE) for details.
+
+## Links
+
+- **npm Registry**: [https://www.npmjs.com/package/@timmsy/riftjs](https://www.npmjs.com/package/@timmsy/riftjs)
+- **GitHub Repository**: [https://github.com/timmsy1998/RiftJS](https://github.com/timmsy1998/RiftJS)
+- **Riot Developer Portal**: [https://developer.riotgames.com/](https://developer.riotgames.com/)

package/endpoints/datadragon.js

@@ -0,0 +1,29 @@
+const axios = require('axios');
+
+module.exports = (baseURL) => ({
+    /**
+     * Get all champion data.
+     * @returns {Promise<object>} Champion data.
+     */
+    async getChampions() {
+        try {
+            const response = await axios.get(`${baseURL}/champion.json`);
+            return response.data;
+        } catch (error) {
+            throw new Error(`DataDragon error: ${error.message}`);
+        }
+    },
+
+    /**
+     * Get all item data.
+     * @returns {Promise<object>} Item data.
+     */
+    async getItems() {
+        try {
+            const response = await axios.get(`${baseURL}/item.json`);
+            return response.data;
+        } catch (error) {
+            throw new Error(`DataDragon error: ${error.message}`);
+        }
+    },
+});

package/endpoints/riot.js

@@ -0,0 +1,84 @@
+module.exports = (client, defaultRegion, regionMap) => ({
+    /**
+     * Get account info by Riot ID (gameName and tagLine).
+     * @param {string} riotId - Riot ID (e.g., "Timmsy#BRUV" or "Timmsy", "BRUV").
+     * @param {string} [tagLine] - Optional tagLine if not included in riotId.
+     * @param {string} [region] - Short region (defaults to constructor region).
+     * @returns {Promise<object>} Account data including puuid.
+     */
+    async getAccountByRiotId(riotId, tagLine = null, region = defaultRegion) {
+        let gameName, tag;
+        if (riotId.includes('#')) {
+            [gameName, tag] = riotId.split('#');
+        } else {
+            gameName = riotId;
+            tag = tagLine || '';
+        }
+        if (!tag) throw new Error('TagLine is required for getAccountByRiotId');
+        const shard = regionMap[region].shard;
+        try {
+            const response = await client.get(`/riot/account/v1/accounts/by-riot-id/${encodeURIComponent(gameName)}/${encodeURIComponent(tag)}`, {
+                baseURL: `https://${shard}`,
+            });
+            return response.data;
+        } catch (error) {
+            throw this._handleError(error);
+        }
+    },
+
+    /**
+     * Get summoner data by PUUID.
+     * @param {string} puuid - Encrypted PUUID.
+     * @param {string} [region] - Short region (defaults to constructor region).
+     * @returns {Promise<object>} Summoner data.
+     */
+    async getSummonerByPuuid(puuid, region = defaultRegion) {
+        const platform = regionMap[region].platform;
+        try {
+            const response = await client.get(`/lol/summoner/v4/summoners/by-puuid/${encodeURIComponent(puuid)}`, {
+                baseURL: `https://${platform}`,
+            });
+            return response.data;
+        } catch (error) {
+            throw this._handleError(error);
+        }
+    },
+
+    /**
+     * Get match history by PUUID.
+     * @param {string} puuid - Summoner's PUUID.
+     * @param {object} [options] - Query options (e.g., start, count).
+     * @param {string} [region] - Short region (defaults to constructor region).
+     * @returns {Promise<string[]>} Array of match IDs.
+     */
+    async getMatchlistByPuuid(puuid, options = {}, region = defaultRegion) {
+        const shard = regionMap[region].shard;
+        try {
+            const response = await client.get(`/lol/match/v5/matches/by-puuid/${encodeURIComponent(puuid)}/ids`, {
+                baseURL: `https://${shard}`,
+                params: options,
+            });
+            return response.data;
+        } catch (error) {
+            throw this._handleError(error);
+        }
+    },
+
+    /**
+     * Get match details by match ID.
+     * @param {string} matchId - Match ID (e.g., "EUW1_1234567890").
+     * @param {string} [region] - Short region (defaults to constructor region).
+     * @returns {Promise<object>} Match data.
+     */
+    async getMatchById(matchId, region = defaultRegion) {
+        const shard = regionMap[region].shard;
+        try {
+            const response = await client.get(`/lol/match/v5/matches/${matchId}`, {
+                baseURL: `https://${shard}`,
+            });
+            return response.data;
+        } catch (error) {
+            throw this._handleError(error);
+        }
+    },
+});

package/index.js

@@ -1,5 +1,28 @@
 require('dotenv').config();
 const axios = require('axios');
+const riotEndpoints = require('./endpoints/riot');
+const dataDragonEndpoints = require('./endpoints/datadragon');
+
+// Region mapping: short region to shard
+const regionMap = {
+    // Platform Routing (short regions)
+    BR1: { platform: 'br1.api.riotgames.com', shard: 'americas.api.riotgames.com' },
+    EUN1: { platform: 'eun1.api.riotgames.com', shard: 'europe.api.riotgames.com' },
+    EUW1: { platform: 'euw1.api.riotgames.com', shard: 'europe.api.riotgames.com' },
+    JP1: { platform: 'jp1.api.riotgames.com', shard: 'asia.api.riotgames.com' },
+    KR: { platform: 'kr.api.riotgames.com', shard: 'asia.api.riotgames.com' },
+    LA1: { platform: 'la1.api.riotgames.com', shard: 'americas.api.riotgames.com' },
+    LA2: { platform: 'la2.api.riotgames.com', shard: 'americas.api.riotgames.com' },
+    NA1: { platform: 'na1.api.riotgames.com', shard: 'americas.api.riotgames.com' },
+    OC1: { platform: 'oc1.api.riotgames.com', shard: 'sea.api.riotgames.com' },
+    TR1: { platform: 'tr1.api.riotgames.com', shard: 'europe.api.riotgames.com' },
+    RU: { platform: 'ru.api.riotgames.com', shard: 'europe.api.riotgames.com' },
+    PH2: { platform: 'ph2.api.riotgames.com', shard: 'sea.api.riotgames.com' },
+    SG2: { platform: 'sg2.api.riotgames.com', shard: 'sea.api.riotgames.com' },
+    TH2: { platform: 'th2.api.riotgames.com', shard: 'sea.api.riotgames.com' },
+    TW2: { platform: 'tw2.api.riotgames.com', shard: 'sea.api.riotgames.com' },
+    VN2: { platform: 'vn2.api.riotgames.com', shard: 'sea.api.riotgames.com' },
+};
 
 /**
  * RiotAPI class for interacting with Riot Games API endpoints.
@@ -8,28 +31,13 @@ class RiotAPI {
     constructor() {
         this.apiKey = process.env.RIOT_API_KEY;
         if (!this.apiKey) throw new Error('RIOT_API_KEY is required in .env');
-        this.region = process.env.REGION || 'euw1';
+        this.region = (process.env.REGION || 'EUW1').toUpperCase();
+        if (!regionMap[this.region]) throw new Error(`Invalid region: ${this.region}`);
         this.client = axios.create({
-            baseURL: `https://${this.region}.api.riotgames.com`,
             headers: { 'X-Riot-Token': this.apiKey },
         });
-    }
-
-    /**
-     * Get summoner data by name.
-     * @param {string} name - Summoner name.
-     * @param {string} [region] - Region (defaults to constructor region).
-     * @returns {Promise<object>} Summoner data.
-     */
-    async getSummonerByName(name, region = this.region) {
-        try {
-            const response = await this.client.get(`/lol/summoner/v4/summoners/by-name/${encodeURIComponent(name)}`, {
-                baseURL: `https://${region}.api.riotgames.com`,
-            });
-            return response.data;
-        } catch (error) {
-            throw this._handleError(error);
-        }
+        // Attach RiotAPI endpoints with region map
+        Object.assign(this, riotEndpoints(this.client, this.region, regionMap));
     }
 
     /**
@@ -55,19 +63,8 @@ class DataDragon {
         this.version = version;
         this.locale = locale;
         this.baseURL = `https://ddragon.leagueoflegends.com/cdn/${this.version}/data/${this.locale}`;
-    }
-
-    /**
-     * Get all champion data.
-     * @returns {Promise<object>} Champion data.
-     */
-    async getChampions() {
-        try {
-            const response = await axios.get(`${this.baseURL}/champion.json`);
-            return response.data;
-        } catch (error) {
-            throw new Error(`DataDragon error: ${error.message}`);
-        }
+        // Attach DataDragon endpoints
+        Object.assign(this, dataDragonEndpoints(this.baseURL));
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@timmsy/riftjs",
-  "version": "1.0.0",
+  "version": "1.5.0",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -9,6 +9,18 @@
     "axios": "^1.7.7",
     "dotenv": "^16.4.5"
   },
+  "keywords": [
+    "riot-api",
+    "league-of-legends",
+    "lol-api",
+    "datadragon",
+    "summoner",
+    "match-history",
+    "game-data",
+    "node-js",
+    "javascript",
+    "api-wrapper"
+  ],
   "author": "James Timms",
   "description": "A lightweight Node.js wrapper for the Riot Games API, providing easy access to League of Legends game data.",
   "license": "MIT",
@@ -16,4 +28,4 @@
     "type": "git",
     "url": "git+https://github.com/timmsy1998/RiftJS.git"
   }
-}
+}