r6-data.js 1.3.6 → 1.5.0

package/README.md

@@ -1,4 +1,5 @@
-## r6-data.js
+# r6-data.js — Rainbow Six Siege (R6/R6S) Stats & Metadata API
+
   Rainbow Six Siege API wrapper that gives infos about player's stats, maps, operators, ranks, seasons, charms etc. Last updated Y10S3
 
   <div align="center">
@@ -14,9 +15,6 @@
 
 ## Installation
 
-```sh
-npm install r6-data.js
-```
 ```sh
 npm i r6-data.js
 ```
@@ -27,6 +25,51 @@ This is the website where you can directly track your stats and also check the a
 
 Visit the official website: **[r6data.eu](https://r6data.eu/)**
 
+## TypeScript Support
+
+r6-data.js now includes full TypeScript support with complete type definitions! You can use it in TypeScript projects with full IntelliSense and type checking.
+
+### TypeScript Import Examples
+
+```typescript
+// ES6 import syntax
+import * as r6 from 'r6-data.js';
+
+// Or import specific functions
+import { getAccountInfo, getPlayerStats, getOperators } from 'r6-data.js';
+
+// Import types for better type safety
+import type { AccountInfoParams, PlayerStatsParams, PlatformType } from 'r6-data.js';
+
+// Example usage with types
+async function getPlayerData() {
+  const accountParams: AccountInfoParams = {
+    nameOnPlatform: 'PlayerName',
+    platformType: 'uplay' as PlatformType
+  };
+  
+  const accountInfo = await r6.getAccountInfo(accountParams);
+  console.log('Account info:', accountInfo);
+}
+```
+
+### JavaScript (CommonJS) Import
+
+```javascript
+// Traditional require syntax (still supported)
+const r6 = require('r6-data.js');
+
+// Example usage
+async function getPlayerData() {
+  const accountInfo = await r6.getAccountInfo({
+    nameOnPlatform: 'PlayerName',
+    platformType: 'uplay'
+  });
+  
+  console.log('Account info:', accountInfo);
+}
+```
+
 ## Getting Player Account Information
 
 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.
@@ -133,6 +176,135 @@ You can filter these statistics by game mode using the `board_id` parameter:
 - `standard`: Statistics for standard matches
 - `ranked`: Statistics for ranked competitive matches
 
+
+## Getting Seasonal Statistics
+
+The `getSeasonalStats()` function allows you to get detailed rank points history and seasonal progression for a specific player in the current season. Includes timestamp, rank information, RP values, and rank images
+
+```javascript
+const r6Info = require('r6-data.js');
+
+async function main() {
+  try {
+    // Get seasonal statistics for a player
+    const seasonalStats = await r6Info.getSeasonalStats({
+      nameOnPlatform: 'PlayerName',
+      platformType: 'uplay'
+    });
+
+    console.log('Seasonal statistics:', seasonalStats);
+    return seasonalStats;
+    
+  } catch (error) {
+    console.error('Error retrieving seasonal statistics:', error.message);
+  }
+}
+
+main();
+```
+
+### Parameters
+
+The `getSeasonalStats()` 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"
+
+### Seasonal Statistics Response
+
+```javascript
+          {
+            "data": {
+                "history": {
+                "metadata": {
+                    "key": "RankPoints",
+                    "name": "Rank Points",
+                    "description": null
+                },
+                "data": [
+                    [
+                    "2025-10-14T21:43:27.315+00:00",
+                    {
+                        "displayName": "Rank Points",
+                        "metadata": {
+                        "rank": "PLATINUM II",
+                        "imageUrl": "https://r6data.eu/assets/img/r6_ranks_img/platinum-2.webp",
+                        "color": "#44ccc2"
+                        },
+                            "value": 3300,
+                            "displayValue": "3,300",
+                            "displayType": "Number"
+                        }
+                    ],
+                    [
+                    "2025-10-14T21:12:55.821+00:00",
+                    {
+                        "displayName": "Rank Points",
+                        "metadata": {
+                        "rank": "PLATINUM II",
+                        "imageUrl": "https://r6data.eu/assets/img/r6_ranks_img/platinum-2.webp",
+                        "color": "#44ccc2"
+                        },
+                            "value": 3302,
+                            "displayValue": "3,302",
+                            "displayType": "Number"
+                        }
+                    ]
+                ]
+                },
+                "leaderboard": null,
+                "expiryDate": "0001-01-01T00:00:00+00:00",
+                "bestMatches": null
+            }
+```
+
+## 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
+
+```javascript
+const r6Info = require('r6-data.js');
+
+async function main() {
+  try {
+    // Get general game statistics
+    const gameStats = await r6Info.getGameStats();
+
+    console.log('Game statistics:', gameStats);
+    return gameStats;
+    
+  } catch (error) {
+    console.error('Error retrieving game statistics:', error.message);
+  }
+}
+
+main();
+```
+
+### Game Statistics Response
+```javascript
+          {
+            "steam": {
+                "concurrent": 33631,
+                "estimate": 33631
+            },
+            "crossPlatform": {
+                "totalRegistered": 85000000,
+                "monthlyActive": 15300000,
+                "trendsEstimate": 175666,
+                "platforms": {
+                    "pc": 6885000,
+                    "playstation": 5355000,
+                    "xbox": 3060000
+                }
+            },
+            "ubisoft": {
+                "onlineEstimate": 127739
+            },
+            "lastUpdated": "2025-10-15T22:39:38.636Z"
+          }
+```
+
 ## Creating Discord Webhooks for R6 Stats
 
 The `createDiscordR6Webhook()` function allows you to send Rainbow Six Siege player statistics directly to a Discord channel using webhooks. This creates formatted embeds with player stats that can be customized with various options.

package/index.d.ts

@@ -0,0 +1,92 @@
+// TypeScript declarations for r6-data.js (module-style, no ambient wrapper)
+
+// ----- Types -----
+export type PlatformType = "uplay" | "psn" | "xbl";
+export type PlatformFamily = "pc" | "console";
+export type BoardId = "casual" | "event" | "warmup" | "standard" | "ranked";
+export type RankVersion = "v1" | "v2" | "v3" | "v4" | "v5" | "v6";
+
+export interface AccountInfoParams {
+  nameOnPlatform: string;
+  platformType: PlatformType;
+}
+export interface PlayerStatsParams extends AccountInfoParams {
+  platform_families: PlatformFamily;
+  board_id?: BoardId;
+}
+export interface SeasonalStatsParams extends AccountInfoParams {}
+
+export interface GetMapsParams {
+  name?: string; location?: string; releaseDate?: string; playlists?: string; mapReworked?: boolean;
+}
+export interface GetOperatorsParams {
+  name?: string; safename?: string; realname?: string; birthplace?: string; age?: number; date_of_birth?: string; season_introduced?: string;
+}
+export interface GetSeasonsParams {
+  name?: string; map?: string; operators?: string; weapons?: string;
+}
+export interface GetAttachmentParams {
+  name?: string; style?: string; rarity?: string; availability?: string;
+}
+export interface GetCharmsParams {
+  name?: string; collection?: string; rarity?: string; availability?: string; bundle?: string; season?: string;
+}
+export interface GetWeaponsParams { name?: string; }
+export interface GetUniversalSkinsParams { name?: string; }
+export interface GetRanksParams { version?: RankVersion; min_mmr?: number; max_mmr?: number; }
+
+export interface SearchAllResult {
+  query: string;
+  summary: Record<string, number>;
+  results: {
+    operators: any[]; weapons: any[]; maps: any[]; seasons: any[]; charms: any[]; attachments: any[];
+    [k: string]: any;
+  };
+}
+export interface GameStats {
+  steam?: { concurrent?: number; estimate?: number };
+  crossPlatform?: { totalRegistered?: number; monthlyActive?: number; trendsEstimate?: number; platforms?: { pc?: number; playstation?: number; xbox?: number } };
+  ubisoft?: { onlineEstimate?: number };
+  lastUpdated?: string;
+  [k: string]: any;
+}
+export interface DiscordWebhookOptions {
+  playerName: string; title?: string; message?: string; color?: number; avatarUrl?: string;
+}
+
+// ----- Functions -----
+export function getAccountInfo(params: AccountInfoParams): Promise<any>;
+export function getPlayerStats(params: PlayerStatsParams): Promise<any>;
+export function getSeasonalStats(params: SeasonalStatsParams): Promise<any>;
+export function getServiceStatus(): Promise<any>;
+export function getGameStats(): Promise<GameStats>;
+export function getMaps(params?: GetMapsParams): Promise<any[]>;
+export function getOperators(params?: GetOperatorsParams): Promise<any[]>;
+export function getSeasons(params?: GetSeasonsParams): Promise<any[]>;
+export function getAttachment(params?: GetAttachmentParams): Promise<any[]>;
+export function getCharms(params?: GetCharmsParams): Promise<any[]>;
+export function getWeapons(params?: GetWeaponsParams): Promise<any[]>;
+export function getUniversalSkins(params?: GetUniversalSkinsParams): Promise<any[]>;
+export function getRanks(params?: GetRanksParams): Promise<any[]>;
+export function getSearchAll(query: string): Promise<SearchAllResult>;
+export function createDiscordR6Webhook(webhookUrl: string, playerData: any, options: DiscordWebhookOptions): Promise<any>;
+
+// ----- Default export -----
+declare const r6Data: {
+  getAccountInfo: typeof getAccountInfo;
+  getPlayerStats: typeof getPlayerStats;
+  getSeasonalStats: typeof getSeasonalStats;
+  getServiceStatus: typeof getServiceStatus;
+  getGameStats: typeof getGameStats;
+  getMaps: typeof getMaps;
+  getOperators: typeof getOperators;
+  getSeasons: typeof getSeasons;
+  getAttachment: typeof getAttachment;
+  getCharms: typeof getCharms;
+  getWeapons: typeof getWeapons;
+  getUniversalSkins: typeof getUniversalSkins;
+  getRanks: typeof getRanks;
+  getSearchAll: typeof getSearchAll;
+  createDiscordR6Webhook: typeof createDiscordR6Webhook;
+};
+export default r6Data;

package/index.js

@@ -11,6 +11,8 @@ const getSearchAll = require('./methods/getSearchAll');
 const getAccountInfo = require('./methods/getAccountInfo');
 const getPlayerStats = require('./methods/getPlayerStats');
 const createDiscordR6Webhook = require('./methods/createDiscordR6Webhook');
+const getGameStats = require('./methods/getGameStats');
+const getSeasonalStats = require('./methods/getSeasonalStats');
 
 const r6Data = {
   getMaps,
@@ -26,6 +28,8 @@ const r6Data = {
   getAccountInfo,
   getPlayerStats,
   createDiscordR6Webhook,
+  getGameStats,
+  getSeasonalStats,
 };
 
 module.exports = r6Data;

package/methods/getGameStats.js

@@ -0,0 +1,30 @@
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege game stats for all platform
+ * @returns {Promise<Object>} - Game stats for all platform
+ */
+async function getGameStats() {
+  try {
+
+      // Build the URL with parameters
+    const params = {
+      type: 'gameStats'
+    };
+
+    const url = buildUrlAndParams('/stats', params);
+
+    const response = await axiosInstance.get(url);
+
+    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/getSeasonalStats.js

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

package/package.json

@@ -1,15 +1,37 @@
 {
   "name": "r6-data.js",
-  "version": "1.3.6",
+  "version": "1.5.0",
   "description": "Rainbow Six Siege API wrapper for player's stats, maps, operators, ranks, seasons, charms etc. Last updated Y10S3",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "types": "./index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "tsconfig.json",
+    "methods/",
+    "axiosInstance/",
+    "README.md"
+  ],
   "scripts": {
-    "test": ""
+    "test": "node -e \"console.log('no tests yet')\"",
+    "lint": "eslint .",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mazeor9/r6-data.js"
   },
+  "homepage": "https://r6data.eu/",
+  "bugs": {
+    "url": "https://github.com/mazeor9/r6-data.js/issues"
+  },
+  "funding": "https://buymeacoffee.com/mazeor",
   "keywords": [
     "r6",
     "rainbow six",
@@ -63,6 +85,8 @@
     "ms": "^2.1.3"
   },
   "devDependencies": {
-    "@types/node": "^24.4.0"
+    "@types/node": "^24.8.0",
+    "eslint": "^9.37.0",
+    "typescript": "^5.9.3"
   }
 }

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "dist"
+  },
+  "include": ["./test.ts"]
+}