r6-data.js 1.0.3 → 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,70 @@ 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;
+    console.log('Account information:', accountInfo);
+    return accountInfo;
     
+  } catch (error) {
+    console.error('Error retrieving account information:', error.message);
+  }
+}
+
+main();
+```
+
+### Parameters
+
+The `getAccountInfo()` 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"
+
+### Account Information Response
+When using `getAccountInfo()`, you'll receive data about the player's profile, including:
+
+- Player level and experience
+- Clearance level
+- Achievement status
+- Play time statistics
+- Player profile settings and customization
+
+## Getting Player Statistics
+
+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 player statistics
-    const playerStats = await r6Info.getStats({
-      type: 'stats',
+    const playerStats = await r6Info.getPlayerStats({
       nameOnPlatform: 'PlayerName',
       platformType: 'uplay',
       platform_families: 'pc'
     });
 
-    return  playerStats;
+    console.log('Player statistics:', playerStats);
+    return playerStats;
 
     // Get player statistics for ranked mode only
-    const rankedStats = await r6Info.getStats({
-      type: 'stats',
+    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 retrieving player data:', error.message);
+    console.error('Error retrieving player statistics:', error.message);
   }
 }
 
@@ -72,43 +105,29 @@ main();
 
 ### Parameters
 
-The `getStats()` function accepts an object with the following parameters:
-For both request types:
+The `getPlayerStats()` 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:
-
-- Player level and experience
-- Clearance level
-- Achievement status
-- Play time statistics
-- Player profile settings and customization
-
-### Player Statistics
-When using the stats type, you'll receive detailed gameplay statistics, including:
+### Player Statistics Response
+  When using `getPlayerStats()`, you'll receive detailed gameplay statistics, including:
 
-- Rank information
-- MMR (Matchmaking Rating)
-- Win/loss records
-- Seasonal performance data
-- Skill metrics across different gameplay modes
+  - 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:
+  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
+  - `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,7 +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 getAccountInfo = require('./methods/getAccountInfo');
+const getPlayerStats = require('./methods/getPlayerStats');
 
 const r6Data = {
   getMaps,
@@ -21,7 +22,8 @@ const r6Data = {
   getWeapons,
   getUniversalSkins,
   getSearchAll,
-  getStats,
+  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,7 +1,7 @@
 {
   "name": "r6-data.js",
-  "version": "1.0.3",
-  "description": "A wrapper for the Rainbow Six Siege API that gives you information about player's stats, maps, operators, ranks, seasons, charms etc",
+  "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": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -44,7 +44,7 @@
   "author": "mazeor",
   "license": "ISC",
   "dependencies": {
-    "axios": "^1.9.0",
+    "axios": "^1.11.0",
     "ms": "^2.1.3"
   },
   "devDependencies": {