r6-data.js 2.0.1 → 2.2.0

package/README.md

@@ -301,6 +301,50 @@ The `getSeasonalStats()` function accepts the API Key and an object with the fol
             }
 ```
 
+## Getting Operator Statistics
+
+The `getOperatorStats()` function allows you to get detailed operator statistics for a specific player.
+
+```javascript
+const r6Info = require('r6-data.js');
+
+async function main() {
+  try {
+    const apiKey = 'YOUR_API_KEY';
+
+    // Get operator statistics for a player
+    const operatorStats = await r6Info.getOperatorStats(apiKey, {
+      nameOnPlatform: 'PlayerName',
+      platformType: 'uplay',
+      // seasonYear: 'Y9S4', // Optional
+      // modes: 'ranked'     // Optional, default is 'ranked'
+    });
+
+    console.log('Operator statistics:', operatorStats);
+    return operatorStats;
+    
+  } catch (error) {
+    console.error('Error retrieving operator statistics:', error.message);
+  }
+}
+
+main();
+```
+
+### Parameters
+
+The `getOperatorStats()` function accepts the API Key and an object with the following parameters:
+
+- `apiKey`: (Required) Your API Key from r6data.eu
+- `nameOnPlatform`: (Required) The player's name on the platform
+- `platformType`: (Required) The platform type - "uplay", "psn", or "xbl"
+- `seasonYear`: (Optional) Season year (e.g., Y9S4, Y10S4)
+- `modes`: (Optional) Game mode (ranked, casual, unranked). Default is 'ranked'.
+
+### Operator Statistics Response
+
+The response contains detailed statistics for each operator played by the user.
+
 ## Getting Game Statistics
 
 The `getGameStats()` function allows you to get real-time player count statistics across all platforms including Steam, Ubisoft Connect, PlayStation, Xbox, and total player counts

package/axiosInstance/axiosInstance.js

@@ -1,4 +1,5 @@
 const axios = require('axios');
+const pkg = require('../package.json');
 
 const axiosInstance = axios.create({
     baseURL: 'https://api.r6data.eu/api',
@@ -6,6 +7,7 @@ const axiosInstance = axios.create({
         'Content-Type': 'application/json',
         'Accept': 'application/json',
         'Cache-Control': 'no-cache',
+        'User-Agent': `r6-data.js/${pkg.version}`,
       },
 });
 

package/index.js

@@ -13,6 +13,7 @@ const getPlayerStats = require('./methods/getPlayerStats');
 const createDiscordR6Webhook = require('./methods/createDiscordR6Webhook');
 const getGameStats = require('./methods/getGameStats');
 const getSeasonalStats = require('./methods/getSeasonalStats');
+const getOperatorStats = require('./methods/getOperatorStats');
 const getPlayerComparisons = require('./methods/getPlayerComparisons');
 const getIsBanned = require('./methods/getIsBanned');
 
@@ -33,6 +34,7 @@ module.exports = {
   createDiscordR6Webhook,
   getGameStats,
   getSeasonalStats,
+  getOperatorStats,
   getPlayerComparisons,
   getIsBanned,
 };
@@ -53,5 +55,6 @@ module.exports.getPlayerStats = getPlayerStats;
 module.exports.createDiscordR6Webhook = createDiscordR6Webhook;
 module.exports.getGameStats = getGameStats;
 module.exports.getSeasonalStats = getSeasonalStats;
+module.exports.getOperatorStats = getOperatorStats;
 module.exports.getPlayerComparisons = getPlayerComparisons;
 module.exports.getIsBanned = getIsBanned;

package/methods/createDiscordR6Webhook.js

@@ -11,7 +11,8 @@ async function createDiscordR6Webhook(webhookUrl, playerData, options = {}) {
     }
 
     // Validate webhook URL format
-    if (!webhookUrl.includes('discord.com/api/webhooks/')) {
+    const discordWebhookRegex = /^https:\/\/(?:ptb\.|canary\.)?discord\.com\/api\/webhooks\/\d+\/[A-Za-z0-9-_]+$/;
+    if (!discordWebhookRegex.test(webhookUrl)) {
       throw new Error('Invalid Discord webhook URL format');
     }
 

package/methods/getAccountInfo.js

@@ -1,47 +1,47 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Get Rainbow Six Siege player account information
- * @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 account information
- */
-async function getAccountInfo(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: 'accountInfo',
-      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 getAccountInfo request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('Authentication error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getAccountInfo;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player account information
+ * @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 account information
+ */
+async function getAccountInfo(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: 'accountInfo',
+      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 getAccountInfo request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getAccountInfo;

package/methods/getAttachment.js

@@ -1,28 +1,28 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util'); 
-
-async function getAttachment(apiKey, { name, style, rarity, availability, bundle, season } = {}) {
-  try {
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-
-    const url = buildUrlAndParams('/attachment', { name, style, rarity, availability, bundle, season });
-
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-
-    return response.data;
-  } catch (error) {
-    console.error('Error during the getAttachment request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('request error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getAttachment;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util'); 
+
+async function getAttachment(apiKey, { name, style, rarity, availability, bundle, season } = {}) {
+  try {
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+
+    const url = buildUrlAndParams('/attachment', { name, style, rarity, availability, bundle, season });
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getAttachment request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('request error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getAttachment;

package/methods/getCharms.js

@@ -1,28 +1,28 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util'); 
-
-async function getCharms(apiKey, { name, collection, rarity, availability, bundle, season } = {}) {
-  try {
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-
-    const url = buildUrlAndParams('/charms', { name, collection, rarity, availability, bundle, season });
-
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-
-    return response.data;
-  } catch (error) {
-    console.error('Errore during the getCharms request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('request error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getCharms;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util'); 
+
+async function getCharms(apiKey, { name, collection, rarity, availability, bundle, season } = {}) {
+  try {
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+
+    const url = buildUrlAndParams('/charms', { name, collection, rarity, availability, bundle, season });
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+
+    return response.data;
+  } catch (error) {
+    console.error('Errore during the getCharms request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('request error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getCharms;

package/methods/getGameStats.js

@@ -1,38 +1,38 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Get Rainbow Six Siege game stats for all platform
- * @param {string} apiKey - Your API Key from r6data.eu
- * @returns {Promise<Object>} - Game stats for all platform
- */
-async function getGameStats(apiKey) {
-  try {
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-
-      // Build the URL with parameters
-    const params = {
-      type: 'gameStats'
-    };
-
-    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 game stats request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('request error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getGameStats;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege game stats for all platform
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @returns {Promise<Object>} - Game stats for all platform
+ */
+async function getGameStats(apiKey) {
+  try {
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+
+      // Build the URL with parameters
+    const params = {
+      type: 'gameStats'
+    };
+
+    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 game stats request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('request error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getGameStats;

package/methods/getIsBanned.js

@@ -1,47 +1,47 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Get Rainbow Six Siege player ban status
- * @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 ban status
- */
-async function getIsBanned(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: 'isBanned',
-      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 getIsBanned request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('Authentication error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getIsBanned;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player ban status
+ * @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 ban status
+ */
+async function getIsBanned(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: 'isBanned',
+      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 getIsBanned request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getIsBanned;

package/methods/getMaps.js

@@ -1,28 +1,28 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-async function getMaps(apiKey, { name, location, releaseDate, playlists, mapReworked } = {}) {
-  try {
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-
-    const url = buildUrlAndParams('/maps', { name, location, releaseDate, playlists, mapReworked });
-
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-
-    return response.data;
-  } catch (error) {
-    console.error('Error during the getMaps request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('request error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getMaps;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+async function getMaps(apiKey, { name, location, releaseDate, playlists, mapReworked } = {}) {
+  try {
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+
+    const url = buildUrlAndParams('/maps', { name, location, releaseDate, playlists, mapReworked });
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getMaps request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('request error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getMaps;

package/methods/getOperatorStats.js

@@ -0,0 +1,54 @@
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege operator stats
+ * @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.seasonYear] - Season year (e.g., Y9S4, Y10S4)
+ * @param {string} [params.modes] - Game mode (ranked, casual, unranked). Default is 'ranked'.
+ * @returns {Promise<Object>} - Operator stats
+ */
+async function getOperatorStats(apiKey, { nameOnPlatform, platformType, seasonYear, modes } = {}) {
+  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: 'operatorStats',
+      nameOnPlatform,
+      platformType,
+      modes
+    };
+
+    if (seasonYear) {
+      params.seasonYear = seasonYear;
+    }
+
+    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 getOperatorStats request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getOperatorStats;

package/methods/getOperators.js

@@ -1,28 +1,28 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util'); 
-
-async function getOperators(apiKey, { name, safename, realname, birthplace, age, date_of_birth, season_introduced, health, speed, unit, country_code, roles, side } = {}) {
-  try {
-    if (!apiKey) {
-      throw new Error('Missing required parameter: apiKey');
-    }
-
-    const url = buildUrlAndParams('/operators', { name, safename, realname, birthplace, age, date_of_birth, season_introduced, health, speed, unit, country_code, roles, side });
-
-    const response = await axiosInstance.get(url, {
-      headers: {
-        'api-key': apiKey
-      }
-    });
-
-    return response.data;
-  } catch (error) {
-    console.error('Error during the getOperators request:', error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('request error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getOperators;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util'); 
+
+async function getOperators(apiKey, { name, safename, realname, birthplace, age, date_of_birth, season_introduced, health, speed, unit, country_code, roles, side } = {}) {
+  try {
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+
+    const url = buildUrlAndParams('/operators', { name, safename, realname, birthplace, age, date_of_birth, season_introduced, health, speed, unit, country_code, roles, side });
+
+    const response = await axiosInstance.get(url, {
+      headers: {
+        'api-key': apiKey
+      }
+    });
+
+    return response.data;
+  } catch (error) {
+    console.error('Error during the getOperators request:', error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('request error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getOperators;