r6-data.js 1.1.0 → 1.2.0

package/README.md

@@ -23,9 +23,9 @@ npm i r6-data.js
 
 ### Last updated Y10S3
 
-## Getting Player Stats and Account Information
+## Getting Player Account Information
 
-The `getStats()` function allows you to retrieve player statistics and account information from the official Rainbow Six Siege API. This function supports two types of requests: `accountInfo` for retrieving player profile data and `stats` for retrieving gameplay statistics.
+The `getAccountInfo()` function allows you to retrieve player profile data from the official Rainbow Six Siege API. This function is specifically designed for retrieving account information such as player level, experience, clearance level, and profile settings.
 
 ```javascript
 const r6Info = require('r6-data.js');
@@ -33,37 +33,16 @@ const r6Info = require('r6-data.js');
 async function main() {
   try {
     // Get player account information
-    const accountInfo = await r6Info.getStats({
-      type: 'accountInfo',
+    const accountInfo = await r6Info.getAccountInfo({
       nameOnPlatform: 'PlayerName',
       platformType: 'uplay'
     });
     
-    return  accountInfo;
-    
-    // Get player statistics
-    const playerStats = await r6Info.getStats({
-      type: 'stats',
-      nameOnPlatform: 'PlayerName',
-      platformType: 'uplay',
-      platform_families: 'pc'
-    });
-
-    return  playerStats;
-
-    // Get player statistics for ranked mode only
-    const rankedStats = await r6Info.getStats({
-      type: 'stats',
-      nameOnPlatform: 'PlayerName',
-      platformType: 'uplay',
-      platform_families: 'pc',
-      board_id: 'ranked'
-    });
-    
-    return rankedStats;
+    console.log('Account information:', accountInfo);
+    return accountInfo;
     
   } catch (error) {
-    console.error('Error retrieving player data:', error.message);
+    console.error('Error retrieving account information:', error.message);
   }
 }
 
@@ -72,20 +51,13 @@ main();
 
 ### Parameters
 
-The `getStats()` function accepts an object with the following parameters:
-For both request types:
+The `getAccountInfo()` function accepts an object with the following parameters:
 
-- `type`: (Required) The type of request - must be either "accountInfo" or "stats"
 - `nameOnPlatform`: (Required) The player's name on the platform
 - `platformType`: (Required) The platform type - "uplay", "psn", or "xbl"
 
-Additional parameters for stats type:
-
-- `platform_families`: (Required) The platform family - "pc" or "console"
-- `board_id`: (Optional) The game mode to filter statistics - "casual", "event", "warmup", "standard", or "ranked"
-
-### Account Information
-When using the `accountInfo` type, you'll receive data about the player's profile, including:
+### Account Information Response
+When using `getAccountInfo()`, you'll receive data about the player's profile, including:
 
 - Player level and experience
 - Clearance level
@@ -93,73 +65,69 @@ When using the `accountInfo` type, you'll receive data about the player's profil
 - Play time statistics
 - Player profile settings and customization
 
-### Player Statistics
-When using the stats type, you'll receive detailed gameplay statistics, including:
-
-- Rank information
-- MMR (Matchmaking Rating)
-- Win/loss records
-- Seasonal performance data
-- Skill metrics across different gameplay modes
-
-You can filter these statistics by game mode using the `board_id` parameter:
-
-- `casual`: Statistics for casual matches
-- `event`: Statistics for limited-time events
-- `warmup`: Statistics for warmup matches
-- `standard`: Statistics for standard matches
-- `ranked`: Statistics for ranked competitive matches
+## Getting Player Statistics
 
-##  Getting Latest Siege News
-The `getLatestSiegeNews()` function allows you to retrieve the latest news and articles from Rainbow Six Siege.
+The `getPlayerStats()` function allows you to retrieve detailed gameplay statistics from the official Rainbow Six Siege API. This function is specifically designed for retrieving player performance data across different game modes.
 
 ```javascript
 const r6Info = require('r6-data.js');
 
 async function main() {
   try {
-    // Get latest Siege news
-    const siegeNews = await r6Info.getLatestSiegeNews();
-    console.log('Siege News:', siegeNews);
-    
-    // Access featured articles
-    console.log('Featured Articles:', siegeNews.featuredArticles);
-    
-    // Access latest articles
-    console.log('Latest Articles:', siegeNews.latestArticles);
-    
-    // Display individual article information
-    siegeNews.featuredArticles.forEach(article => {
-      console.log(`Title: ${article.title}`);
-      console.log(`Link: ${article.link}`);
-      console.log(`Type: ${article.type}`);
-      console.log(`Scraped at: ${article.scrapedAt}`);
-      console.log('---');
+    // Get player statistics
+    const playerStats = await r6Info.getPlayerStats({
+      nameOnPlatform: 'PlayerName',
+      platformType: 'uplay',
+      platform_families: 'pc'
+    });
+
+    console.log('Player statistics:', playerStats);
+    return playerStats;
+
+    // Get player statistics for ranked mode only
+    const rankedStats = await r6Info.getPlayerStats({
+      nameOnPlatform: 'PlayerName',
+      platformType: 'uplay',
+      platform_families: 'pc',
+      board_id: 'ranked'
     });
     
+    console.log('Ranked statistics:', rankedStats);
+    return rankedStats;
+    
   } catch (error) {
-    console.error('Error while fetching Siege news:', error.message);
+    console.error('Error retrieving player statistics:', error.message);
   }
 }
 
 main();
 ```
 
-### News Response Structure
-The function returns an object containing:
+### Parameters
+
+The `getPlayerStats()` function accepts an object with the following parameters:
+
+- `nameOnPlatform`: (Required) The player's name on the platform
+- `platformType`: (Required) The platform type - "uplay", "psn", or "xbl"
+- `platform_families`: (Required) The platform family - "pc" or "console"
+- `board_id`: (Optional) The game mode to filter statistics - "casual", "event", "warmup", "standard", or "ranked"
+
+### Player Statistics Response
+  When using `getPlayerStats()`, you'll receive detailed gameplay statistics, including:
 
-`featuredArticles`: Array of up to 5 featured articles from siege.gg
-`latestArticles`: Array of up to 10 latest articles from siege.gg
-`scrapedAt`: Timestamp indicating when the data was retrieved
+  - Rank information
+  - MMR (Matchmaking Rating)
+  - Win/loss records
+  - Seasonal performance data
+  - Skill metrics across different gameplay modes
 
-Each article object contains:
+  You can filter these statistics by game mode using the `board_id` parameter:
 
-`title`: The article title (cleaned from "Siege" suffix)
-`imageUrl`: URL of the article's featured image
-`link`: Full URL to the article
-`type`: Article type ("featured" or "latest")
-`category`: Article category (for latest articles: "news" or "general")
-`scrapedAt`: Timestamp of when the article was scraped
+  - `casual`: Statistics for casual matches
+  - `event`: Statistics for limited-time events
+  - `warmup`: Statistics for warmup matches
+  - `standard`: Statistics for standard matches
+  - `ranked`: Statistics for ranked competitive matches
 
 ## Searching Across All Entities
 

package/index.js

@@ -8,8 +8,8 @@ const getCharms = require('./methods/getCharms');
 const getWeapons = require('./methods/getWeapons');
 const getUniversalSkins = require('./methods/getUniversalSkins');
 const getSearchAll = require('./methods/getSearchAll');
-const getStats = require('./methods/getStats');
-const getLatestSiegeNews = require('./methods/getLatestSiegeNews');
+const getAccountInfo = require('./methods/getAccountInfo');
+const getPlayerStats = require('./methods/getPlayerStats');
 
 const r6Data = {
   getMaps,
@@ -22,8 +22,8 @@ const r6Data = {
   getWeapons,
   getUniversalSkins,
   getSearchAll,
-  getStats,
-  getLatestSiegeNews,
+  getAccountInfo,
+  getPlayerStats,
 };
 
 module.exports = r6Data;

package/methods/getAccountInfo.js

@@ -0,0 +1,39 @@
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player account information
+ * @param {Object} params - Parameters for the request
+ * @param {string} params.nameOnPlatform - Player name on the platform
+ * @param {string} params.platformType - Platform type (uplay, psn, xbl)
+ * @returns {Promise<Object>} - Player account information
+ */
+async function getAccountInfo({ nameOnPlatform, platformType } = {}) {
+  try {
+    // Validate required parameters
+    if (!nameOnPlatform || !platformType) {
+      throw new Error('Missing required parameters: nameOnPlatform, platformType');
+    }
+
+    // Build the URL with parameters
+    const params = {
+      type: 'accountInfo',
+      nameOnPlatform,
+      platformType
+    };
+
+    const url = buildUrlAndParams('/stats', params);
+
+    const response = await axiosInstance.get(url);
+    
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getAccountInfo request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getAccountInfo;

package/methods/getPlayerStats.js

@@ -0,0 +1,75 @@
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player statistics
+ * @param {Object} params - Parameters for the request
+ * @param {string} params.nameOnPlatform - Player name on the platform
+ * @param {string} params.platformType - Platform type (uplay, psn, xbl)
+ * @param {string} params.platform_families - Platform families: "pc" or "console"
+ * @param {string} [params.board_id] - Game mode to filter stats (casual, event, warmup, standard, ranked)
+ * @returns {Promise<Object>} - Player statistics
+ */
+async function getPlayerStats({ nameOnPlatform, platformType, platform_families, board_id } = {}) {
+  try {
+    // Validate required parameters
+    if (!nameOnPlatform || !platformType || !platform_families) {
+      throw new Error('Missing required parameters: nameOnPlatform, platformType, platform_families');
+    }
+
+    // Validate board_id if provided
+    if (board_id && !['casual', 'event', 'warmup', 'standard', 'ranked'].includes(board_id)) {
+      throw new Error('Invalid board_id. Must be one of: casual, event, warmup, standard, ranked');
+    }
+
+    // Build the URL with parameters
+    const params = {
+      type: 'stats',
+      nameOnPlatform,
+      platformType,
+      platform_families
+    };
+
+    // Add board_id if provided
+    if (board_id) {
+      params.board_id = board_id;
+    }
+
+    const url = buildUrlAndParams('/stats', params);
+
+    const response = await axiosInstance.get(url);
+    
+    if (response.data && 
+        response.data.platform_families_full_profiles && 
+        response.data.platform_families_full_profiles.length > 0) {
+      
+      // If board_id is specified, filter the response data
+      if (board_id && response.data.platform_families_full_profiles) {
+        response.data.platform_families_full_profiles.forEach(profile => {
+          if (profile.board_ids_full_profiles) {
+            // Filter to only include the specified board_id
+            profile.board_ids_full_profiles = profile.board_ids_full_profiles.filter(
+              board => board.board_id === board_id
+            );
+          }
+        });
+      }
+      
+      response.data.platform_families_full_profiles.forEach(profile => {
+        if (profile.board_ids_full_profiles) {
+          console.log(JSON.stringify(profile.board_ids_full_profiles, null, 2));
+        }
+      });
+    }
+    
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getPlayerStats request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getPlayerStats;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "r6-data.js",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A wrapper for Rainbow Six Siege API that gives you information about player's stats, maps, operators, ranks, seasons, charms etc",
   "main": "index.js",
   "scripts": {
@@ -45,7 +45,6 @@
   "license": "ISC",
   "dependencies": {
     "axios": "^1.11.0",
-    "cheerio": "^1.1.0",
     "ms": "^2.1.3"
   },
   "devDependencies": {

package/methods/getLatestSiegeNews.js

@@ -1,60 +0,0 @@
-const cheerio = require('cheerio');
-
-async function getLatestSiegeNews() {
-  try {
-    const response = await fetch('https://siege.gg/');
-    const html = await response.text();
-    const $ = cheerio.load(html);
-
-    const featuredArticles = [];
-    const latestArticles = [];
-
-    // Estrae Featured Articles
-    $('h2:contains("Featured Articles")').parent().find('a').each((index, article) => {
-      const title = $(article).find('img').attr('alt') || '';
-      const imageUrl = $(article).find('img').attr('src') || '';
-      const link = $(article).attr('href') || '';
-
-      if (title && link) {
-        featuredArticles.push({
-          title: title.replace(' Siege', '').trim(),
-          imageUrl,
-          link: link.startsWith('http') ? link : `https://siege.gg${link}`,
-          type: 'featured',
-          scrapedAt: new Date().toISOString()
-        });
-      }
-    });
-
-    // Estrae Latest Articles
-    $('h2:contains("Latest Articles")').parent().find('a').each((index, article) => {
-      const title = $(article).find('img').attr('alt') || '';
-      const imageUrl = $(article).find('img').attr('src') || '';
-      const link = $(article).attr('href') || '';
-      const category = $(article).text().includes('News') ? 'news' : 'general';
-
-      if (title && link) {
-        latestArticles.push({
-          title: title.replace(' Siege', '').trim(),
-          imageUrl,
-          link: link.startsWith('http') ? link : `https://siege.gg${link}`,
-          category,
-          type: 'latest',
-          scrapedAt: new Date().toISOString()
-        });
-      }
-    });
-
-    return {
-      featuredArticles: featuredArticles.slice(0, 5),
-      latestArticles: latestArticles.slice(0, 10),
-      scrapedAt: new Date().toISOString()
-    };
-
-  } catch (error) {
-    console.error('Error fetching siege news:', error.message);
-    throw new Error(`Error fetching siege news: ${error.message}`);
-  }
-}
-
-module.exports = getLatestSiegeNews;