r6-data.js 2.0.1 → 2.2.0

package/methods/getPlayerComparisons.js

@@ -1,121 +1,121 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Compare Rainbow Six Siege player statistics between multiple players
- * @param {string} apiKey - Your API Key from r6data.eu
- * @param {Object} params - Parameters for the request
- * @param {Array<Object>} params.players - Array of player objects to compare
- * @param {string} params.players[].nameOnPlatform - Player name on the platform
- * @param {string} params.players[].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)
- * @param {Array<string>} [params.compareFields] - Specific fields to compare (e.g., ['kills', 'deaths', 'wins', 'losses'])
- * @returns {Promise<Object>} - Comparison results with player statistics and comparison metrics
- */
-async function getPlayerComparisons(apiKey, { players, platform_families, board_id, compareFields } = {}) {
-  try {
-    // Validate required parameters
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-    if (!players || !Array.isArray(players) || players.length < 2) {
-      throw new Error('At least 2 players are required for comparison');
-    }
-
-    if (!platform_families) {
-      throw new Error('Missing required parameter: platform_families');
-    }
-
-    // Validate each player object
-    for (let i = 0; i < players.length; i++) {
-      const player = players[i];
-      if (!player.nameOnPlatform || !player.platformType) {
-        throw new Error(`Player ${i + 1} is missing required fields: nameOnPlatform, platformType`);
-      }
-    }
-
-    // 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');
-    }
-
-    // Fetch stats for each player
-    const playerStats = [];
-    const errors = [];
-
-    for (const player of players) {
-      try {
-        const params = {
-          type: 'stats',
-          nameOnPlatform: player.nameOnPlatform,
-          platformType: player.platformType,
-          platform_families
-        };
-
-        if (board_id) {
-          params.board_id = board_id;
-        }
-
-        const url = buildUrlAndParams('/stats', params);
-        const response = await axiosInstance.get(url, {
-          headers: {
-        'api-key': apiKey
-      }
-        });
-
-        if (response.data && 
-            response.data.platform_families_full_profiles && 
-            response.data.platform_families_full_profiles.length > 0) {
-          
-          // Filter by board_id if specified
-          if (board_id && response.data.platform_families_full_profiles) {
-            response.data.platform_families_full_profiles.forEach(profile => {
-              if (profile.board_ids_full_profiles) {
-                profile.board_ids_full_profiles = profile.board_ids_full_profiles.filter(
-                  board => board.board_id === board_id
-                );
-              }
-            });
-          }
-
-          playerStats.push({
-            player: player,
-            stats: response.data,
-            success: true
-          });
-        } else {
-          playerStats.push({
-            player: player,
-            stats: null,
-            success: false,
-            error: 'No stats found for player'
-          });
-        }
-      } catch (error) {
-        errors.push({
-          player: player,
-          error: error.message
-        });
-        playerStats.push({
-          player: player,
-          stats: null,
-          success: false,
-          error: error.message
-        });
-      }
-    }
-    
-    // Logic for comparison could be added here if needed, but returning collected stats for now
-    return {
-      comparisons: playerStats,
-      errors: errors.length > 0 ? errors : undefined
-    };
-
-  } catch (error) {
-    console.error('Error during the getPlayerComparisons request:', error.message);
-    throw error;
-  }
-}
-
-module.exports = getPlayerComparisons;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Compare Rainbow Six Siege player statistics between multiple players
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @param {Object} params - Parameters for the request
+ * @param {Array<Object>} params.players - Array of player objects to compare
+ * @param {string} params.players[].nameOnPlatform - Player name on the platform
+ * @param {string} params.players[].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)
+ * @param {Array<string>} [params.compareFields] - Specific fields to compare (e.g., ['kills', 'deaths', 'wins', 'losses'])
+ * @returns {Promise<Object>} - Comparison results with player statistics and comparison metrics
+ */
+async function getPlayerComparisons(apiKey, { players, platform_families, board_id, compareFields } = {}) {
+  try {
+    // Validate required parameters
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+    if (!players || !Array.isArray(players) || players.length < 2) {
+      throw new Error('At least 2 players are required for comparison');
+    }
+
+    if (!platform_families) {
+      throw new Error('Missing required parameter: platform_families');
+    }
+
+    // Validate each player object
+    for (let i = 0; i < players.length; i++) {
+      const player = players[i];
+      if (!player.nameOnPlatform || !player.platformType) {
+        throw new Error(`Player ${i + 1} is missing required fields: nameOnPlatform, platformType`);
+      }
+    }
+
+    // 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');
+    }
+
+    // Fetch stats for each player
+    const playerStats = [];
+    const errors = [];
+
+    for (const player of players) {
+      try {
+        const params = {
+          type: 'stats',
+          nameOnPlatform: player.nameOnPlatform,
+          platformType: player.platformType,
+          platform_families
+        };
+
+        if (board_id) {
+          params.board_id = board_id;
+        }
+
+        const url = buildUrlAndParams('/stats', params);
+        const response = await axiosInstance.get(url, {
+          headers: {
+        'api-key': apiKey
+      }
+        });
+
+        if (response.data && 
+            response.data.platform_families_full_profiles && 
+            response.data.platform_families_full_profiles.length > 0) {
+          
+          // Filter by board_id if specified
+          if (board_id && response.data.platform_families_full_profiles) {
+            response.data.platform_families_full_profiles.forEach(profile => {
+              if (profile.board_ids_full_profiles) {
+                profile.board_ids_full_profiles = profile.board_ids_full_profiles.filter(
+                  board => board.board_id === board_id
+                );
+              }
+            });
+          }
+
+          playerStats.push({
+            player: player,
+            stats: response.data,
+            success: true
+          });
+        } else {
+          playerStats.push({
+            player: player,
+            stats: null,
+            success: false,
+            error: 'No stats found for player'
+          });
+        }
+      } catch (error) {
+        errors.push({
+          player: player,
+          error: error.message
+        });
+        playerStats.push({
+          player: player,
+          stats: null,
+          success: false,
+          error: error.message
+        });
+      }
+    }
+    
+    // Logic for comparison could be added here if needed, but returning collected stats for now
+    return {
+      comparisons: playerStats,
+      errors: errors.length > 0 ? errors : undefined
+    };
+
+  } catch (error) {
+    console.error('Error during the getPlayerComparisons request:', error.message);
+    throw error;
+  }
+}
+
+module.exports = getPlayerComparisons;

package/methods/getPlayerStats.js

@@ -1,83 +1,77 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Get Rainbow Six Siege player statistics
- * @param {string} apiKey - Your API Key from r6data.eu
- * @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(apiKey, { nameOnPlatform, platformType, platform_families, board_id } = {}) {
-  try {
-    // Validate required parameters
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-    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, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-    
-    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;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player statistics
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @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(apiKey, { nameOnPlatform, platformType, platform_families, board_id } = {}) {
+  try {
+    // Validate required parameters
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+    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, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+    
+    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
+            );
+          }
+        });
+      }
+    }
+    
+    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/methods/getRanks.js

@@ -1,32 +1,32 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util'); 
-
-async function getRanks(apiKey, { name, min_mmr, max_mmr, version } = {}) {
-  try {
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-
-    if (!['v1', 'v2', 'v3', 'v4', 'v5', 'v6'].includes(version)) {
-      throw new Error('Version not valid. Choose between v1, v2, v3, v4, v5, and v6.');
-    }
-
-    const url = buildUrlAndParams('/ranks', { name, min_mmr, max_mmr, version });
-
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-
-    return response.data;
-  } catch (error) {
-    console.error('Error during the getRanks request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('request error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getRanks;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util'); 
+
+async function getRanks(apiKey, { name, min_mmr, max_mmr, version } = {}) {
+  try {
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+
+    if (!['v1', 'v2', 'v3', 'v4', 'v5', 'v6'].includes(version)) {
+      throw new Error('Version not valid. Choose between v1, v2, v3, v4, v5, and v6.');
+    }
+
+    const url = buildUrlAndParams('/ranks', { name, min_mmr, max_mmr, version });
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getRanks request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('request error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getRanks;

package/methods/getSearchAll.js

@@ -1,35 +1,35 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Search across all R6 entities (operators, weapons, maps, etc.)
- * @param {string} apiKey - Your API Key from r6data.eu
- * @param {string} query - The search term to query across all entities
- * @returns {Promise<Object>} - Search results organized by entity type
- */
-async function getSearchAll(apiKey, query) {
-  if (!apiKey) {
-    throw new Error('Missing required parameter: apiKey');
-  }
-  if (!query || typeof query !== 'string') {
-    throw new Error('Search query is required and must be a string');
-  }
-
-  try {
-    const url = buildUrlAndParams('/searchAll', { q: query });
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-    return response.data;
-  } catch (error) {
-    console.error('Error during the getSearchAll request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('Authentication error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getSearchAll;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Search across all R6 entities (operators, weapons, maps, etc.)
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @param {string} query - The search term to query across all entities
+ * @returns {Promise<Object>} - Search results organized by entity type
+ */
+async function getSearchAll(apiKey, query) {
+  if (!apiKey) {
+    throw new Error('Missing required parameter: apiKey');
+  }
+  if (!query || typeof query !== 'string') {
+    throw new Error('Search query is required and must be a string');
+  }
+
+  try {
+    const url = buildUrlAndParams('/searchAll', { q: query });
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getSearchAll request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getSearchAll;

package/methods/getSeasonalStats.js

@@ -1,47 +1,47 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Get Rainbow Six Siege player stats for current season
- * @param {string} apiKey - Your API Key from r6data.eu
- * @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 stats for current season
- */
-async function getSeasonalStats(apiKey, { nameOnPlatform, platformType } = {}) {
-  try {
-    // Validate required parameters
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-    if (!nameOnPlatform || !platformType) {
-      throw new Error('Missing required parameters: nameOnPlatform, platformType');
-    }
-
-    // Build the URL with parameters
-    const params = {
-      type: 'seasonalStats',
-      nameOnPlatform,
-      platformType
-    };
-
-    const url = buildUrlAndParams('/stats', params);
-
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-    
-    return response.data;
-  } catch (error) {
-    console.error('Error during the getSeasonalStats request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('Authentication error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getSeasonalStats;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player stats for current season
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @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 stats for current season
+ */
+async function getSeasonalStats(apiKey, { nameOnPlatform, platformType } = {}) {
+  try {
+    // Validate required parameters
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+    if (!nameOnPlatform || !platformType) {
+      throw new Error('Missing required parameters: nameOnPlatform, platformType');
+    }
+
+    // Build the URL with parameters
+    const params = {
+      type: 'seasonalStats',
+      nameOnPlatform,
+      platformType
+    };
+
+    const url = buildUrlAndParams('/stats', params);
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+    
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getSeasonalStats request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getSeasonalStats;