r6-data.js 1.8.3 → 2.0.1

package/methods/getStats.js

@@ -1,90 +1,98 @@
-const axiosInstance = require('../axiosInstance/axiosInstance');
-const buildUrlAndParams = require('./util');
-
-/**
- * Get Rainbow Six Siege player stats or account information
- * @param {Object} params - Parameters for the request
- * @param {string} params.type - Type of request: "accountInfo" or "stats"
- * @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 (required for stats type): "pc" or "console"
- * @param {string} [params.board_id] - Game mode to filter stats (casual, event, warmup, standard, ranked)
- * @returns {Promise<Object>} - Player stats or account information
- */
-async function getStats({ type, nameOnPlatform, platformType, platform_families, board_id } = {}) {
-  try {
-    // Validate required parameters
-    if (!type || !nameOnPlatform || !platformType) {
-      throw new Error('Missing required parameters: type, nameOnPlatform, platformType');
-    }
-
-    // Validate type parameter
-    if (type !== 'accountInfo' && type !== 'stats') {
-      throw new Error('Invalid type parameter. Must be "accountInfo" or "stats"');
-    }
-
-    // If type is stats, platform_families is required
-    if (type === 'stats' && !platform_families) {
-      throw new Error('platform_families parameter is required for stats type');
-    }
-
-    // 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,
-      nameOnPlatform,
-      platformType
-    };
-
-    // Add platform_families for stats type
-    if (type === 'stats') {
-      params.platform_families = 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 (type === 'stats' && 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 getStats (${type}) request:`, error.message);
-    if (error.response && error.response.status === 401) {
-      throw new Error('Authentication error');
-    }
-    throw error;
-  }
-}
-
-module.exports = getStats;
+const axiosInstance = require('../axiosInstance/axiosInstance');
+const buildUrlAndParams = require('./util');
+
+/**
+ * Get Rainbow Six Siege player stats or account information
+ * @param {string} apiKey - Your API Key from r6data.eu
+ * @param {Object} params - Parameters for the request
+ * @param {string} params.type - Type of request: "accountInfo" or "stats"
+ * @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 (required for stats type): "pc" or "console"
+ * @param {string} [params.board_id] - Game mode to filter stats (casual, event, warmup, standard, ranked)
+ * @returns {Promise<Object>} - Player stats or account information
+ */
+async function getStats(apiKey, { type, nameOnPlatform, platformType, platform_families, board_id } = {}) {
+  try {
+    // Validate required parameters
+    if (!apiKey) {
+      throw new Error('Missing required parameter: apiKey');
+    }
+    if (!type || !nameOnPlatform || !platformType) {
+      throw new Error('Missing required parameters: type, nameOnPlatform, platformType');
+    }
+
+    // Validate type parameter
+    if (type !== 'accountInfo' && type !== 'stats') {
+      throw new Error('Invalid type parameter. Must be "accountInfo" or "stats"');
+    }
+
+    // If type is stats, platform_families is required
+    if (type === 'stats' && !platform_families) {
+      throw new Error('platform_families parameter is required for stats type');
+    }
+
+    // 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,
+      nameOnPlatform,
+      platformType
+    };
+
+    // Add platform_families for stats type
+    if (type === 'stats') {
+      params.platform_families = 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 (type === 'stats' && 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 getStats (${type}) request:`, error.message);
+    if (error.response && error.response.status === 401) {
+      throw new Error('Authentication error');
+    }
+    throw error;
+  }
+}
+
+module.exports = getStats;

package/methods/getUniversalSkins.js

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

package/methods/getWeapons.js

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

package/package.json

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

package/types/function-declarations.d.ts

@@ -1,42 +1,42 @@
-// Function declarations for r6-data.js
-
-import {
-  AccountInfoParams,
-  GetIsBannedParams,
-  PlayerStatsParams,
-  SeasonalStatsParams,
-  PlayerComparisonsParams,
-  GetMapsParams,
-  GetOperatorsParams,
-  GetSeasonsParams,
-  GetAttachmentParams,
-  GetCharmsParams,
-  GetWeaponsParams,
-  GetUniversalSkinsParams,
-  GetRanksParams,
-  DiscordWebhookOptions
-} from './params-interfaces';
-
-import {
-  SearchAllResult,
-  GameStats,
-  PlayerComparisonsResult
-} 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>;
-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>;
-export function getPlayerComparisons(params: PlayerComparisonsParams): Promise<PlayerComparisonsResult>;
+// Function declarations for r6-data.js
+
+import {
+  AccountInfoParams,
+  GetIsBannedParams,
+  PlayerStatsParams,
+  SeasonalStatsParams,
+  PlayerComparisonsParams,
+  GetMapsParams,
+  GetOperatorsParams,
+  GetSeasonsParams,
+  GetAttachmentParams,
+  GetCharmsParams,
+  GetWeaponsParams,
+  GetUniversalSkinsParams,
+  GetRanksParams,
+  DiscordWebhookOptions
+} from './params-interfaces';
+
+import {
+  SearchAllResult,
+  GameStats,
+  PlayerComparisonsResult
+} from './result-interfaces';
+
+export function getAccountInfo(apiKey: string, params: AccountInfoParams): Promise<any>;
+export function getIsBanned(apiKey: string, params: GetIsBannedParams): Promise<any>;
+export function getPlayerStats(apiKey: string, params: PlayerStatsParams): Promise<any>;
+export function getSeasonalStats(apiKey: string, params: SeasonalStatsParams): Promise<any>;
+export function getServiceStatus(apiKey: string): Promise<any>;
+export function getGameStats(apiKey: string): Promise<GameStats>;
+export function getMaps(apiKey: string, params?: GetMapsParams): Promise<any[]>;
+export function getOperators(apiKey: string, params?: GetOperatorsParams): Promise<any[]>;
+export function getSeasons(apiKey: string, params?: GetSeasonsParams): Promise<any[]>;
+export function getAttachment(apiKey: string, params?: GetAttachmentParams): Promise<any[]>;
+export function getCharms(apiKey: string, params?: GetCharmsParams): Promise<any[]>;
+export function getWeapons(apiKey: string, params?: GetWeaponsParams): Promise<any[]>;
+export function getUniversalSkins(apiKey: string, params?: GetUniversalSkinsParams): Promise<any[]>;
+export function getRanks(apiKey: string, params?: GetRanksParams): Promise<any[]>;
+export function getSearchAll(apiKey: string, query: string): Promise<SearchAllResult>;
+export function createDiscordR6Webhook(webhookUrl: string, playerData: any, options: DiscordWebhookOptions): Promise<any>;
+export function getPlayerComparisons(apiKey: string, params: PlayerComparisonsParams): Promise<PlayerComparisonsResult>;

package/types/params-interfaces.d.ts

@@ -1,90 +1,90 @@
-// Parameter interfaces for r6-data.js
-
-import { PlatformType, PlatformFamily, BoardId, RankVersion } from './base-types';
-
-export interface AccountInfoParams {
-  nameOnPlatform: string;
-  platformType: PlatformType;
-}
-
-export interface GetIsBannedParams extends AccountInfoParams {}
-
-export interface PlayerStatsParams extends AccountInfoParams {
-  platform_families: PlatformFamily;
-  board_id?: BoardId;
-}
-
-export interface SeasonalStatsParams extends AccountInfoParams {}
-
-export interface PlayerComparisonsParams {
-  players: Array<{
-    nameOnPlatform: string;
-    platformType: PlatformType;
-  }>;
-  platform_families: PlatformFamily;
-  board_id?: BoardId;
-  compareFields?: string[];
-}
-
-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 DiscordWebhookOptions {
-  playerName: string;
-  title?: string;
-  message?: string;
-  color?: number;
-  avatarUrl?: string;
+// Parameter interfaces for r6-data.js
+
+import { PlatformType, PlatformFamily, BoardId, RankVersion } from './base-types';
+
+export interface AccountInfoParams {
+  nameOnPlatform: string;
+  platformType: PlatformType;
+}
+
+export interface GetIsBannedParams extends AccountInfoParams {}
+
+export interface PlayerStatsParams extends AccountInfoParams {
+  platform_families: PlatformFamily;
+  board_id?: BoardId;
+}
+
+export interface SeasonalStatsParams extends AccountInfoParams {}
+
+export interface PlayerComparisonsParams {
+  players: Array<{
+    nameOnPlatform: string;
+    platformType: PlatformType;
+  }>;
+  platform_families: PlatformFamily;
+  board_id?: BoardId;
+  compareFields?: string[];
+}
+
+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 DiscordWebhookOptions {
+  playerName: string;
+  title?: string;
+  message?: string;
+  color?: number;
+  avatarUrl?: string;
 }