r6-data.js 1.7.3 → 1.8.2

package/README.md

@@ -95,6 +95,42 @@ When using `getAccountInfo()`, you'll receive data about the player's profile, i
 - Play time statistics
 - Player profile settings and customization
 
+## Getting Player Ban Status
+
+The `getIsBanned()` function allows you to check if a player is currently banned from Rainbow Six Siege.
+
+```javascript
+const r6Info = require('r6-data.js');
+
+async function main() {
+  try {
+    // Check if player is banned
+    const banStatus = await r6Info.getIsBanned({
+      nameOnPlatform: 'PlayerName',
+      platformType: 'uplay'
+    });
+    
+    console.log('Ban status:', banStatus);
+    return banStatus;
+    
+  } catch (error) {
+    console.error('Error checking ban status:', error.message);
+  }
+}
+
+main();
+```
+
+### Parameters
+
+The `getIsBanned()` 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"
+
+### Ban Status Response
+When using `getIsBanned()`, you'll receive data indicating the player's ban status.
+
 ## 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.

package/axiosInstance/axiosInstance.js

@@ -1,7 +1,7 @@
 const axios = require('axios');
 
 const axiosInstance = axios.create({
-    baseURL: 'https://r6-api.vercel.app/api',
+    baseURL: 'https://api.r6data.eu/api',
     headers: {
         'Content-Type': 'application/json',
         'Accept': 'application/json',

package/index.d.ts

@@ -1,4 +1,4 @@
-// TypeScript declarations for r6-data.js (module-style, no ambient wrapper)
+// TypeScript declarations for r6-data.js
 
 // Re-export all types and interfaces from modular files
 export * from './types';
@@ -6,6 +6,7 @@ export * from './types';
 // ----- Default export -----
 import {
   getAccountInfo,
+  getIsBanned,
   getPlayerStats,
   getSeasonalStats,
   getServiceStatus,
@@ -25,6 +26,7 @@ import {
 
 declare const r6Data: {
   getAccountInfo: typeof getAccountInfo;
+  getIsBanned: typeof getIsBanned;
   getPlayerStats: typeof getPlayerStats;
   getSeasonalStats: typeof getSeasonalStats;
   getServiceStatus: typeof getServiceStatus;

package/index.js

@@ -14,6 +14,7 @@ const createDiscordR6Webhook = require('./methods/createDiscordR6Webhook');
 const getGameStats = require('./methods/getGameStats');
 const getSeasonalStats = require('./methods/getSeasonalStats');
 const getPlayerComparisons = require('./methods/getPlayerComparisons');
+const getIsBanned = require('./methods/getIsBanned');
 
 // Export individual functions for named imports
 module.exports = {
@@ -33,6 +34,7 @@ module.exports = {
   getGameStats,
   getSeasonalStats,
   getPlayerComparisons,
+  getIsBanned,
 };
 
 // Export individual functions as named exports for ES6 compatibility
@@ -51,4 +53,5 @@ module.exports.getPlayerStats = getPlayerStats;
 module.exports.createDiscordR6Webhook = createDiscordR6Webhook;
 module.exports.getGameStats = getGameStats;
 module.exports.getSeasonalStats = getSeasonalStats;
-module.exports.getPlayerComparisons = getPlayerComparisons;
+module.exports.getPlayerComparisons = getPlayerComparisons;
+module.exports.getIsBanned = getIsBanned;

package/methods/getIsBanned.js

@@ -0,0 +1,39 @@
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player ban status
+ * @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({ 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: 'isBanned',
+      nameOnPlatform,
+      platformType
+    };
+
+    const url = buildUrlAndParams('/stats', params);
+
+    const response = await axiosInstance.get(url);
+    
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "r6-data.js",
-  "version": "1.7.3",
+  "version": "1.8.2",
   "description": "R6 (Rainbow Six Siege) API wrapper for player stats, operators, maps, ranks, seasons, and game data. Typescript support. Last Updated Y10S4",
   "main": "index.js",
   "module": "index.js",

package/types/function-declarations.d.ts

@@ -2,6 +2,7 @@
 
 import {
   AccountInfoParams,
+  GetIsBannedParams,
   PlayerStatsParams,
   SeasonalStatsParams,
   PlayerComparisonsParams,
@@ -23,6 +24,7 @@ import {
 } from './result-interfaces';
 
 export function getAccountInfo(params: AccountInfoParams): Promise<any>;
+export function getIsBanned(params: GetIsBannedParams): Promise<any>;
 export function getPlayerStats(params: PlayerStatsParams): Promise<any>;
 export function getSeasonalStats(params: SeasonalStatsParams): Promise<any>;
 export function getServiceStatus(): Promise<any>;

package/types/params-interfaces.d.ts

@@ -7,6 +7,8 @@ export interface AccountInfoParams {
   platformType: PlatformType;
 }
 
+export interface GetIsBannedParams extends AccountInfoParams {}
+
 export interface PlayerStatsParams extends AccountInfoParams {
   platform_families: PlatformFamily;
   board_id?: BoardId;