r6-data.js 1.7.0 → 1.7.2

package/README.md

@@ -1,4 +1,4 @@
-# r6-data.js — Complete R6 Rainbow Six Siege API Wrapper
+# r6-data.js — R6 Rainbow Six Siege API Wrapper
 
 **Rainbow Six Siege (R6) API wrapper** - Get player stats, operators, maps, ranks, seasons, charms and more. Full TypeScript support included. Last updated Y10S3.3
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "r6-data.js",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "R6 (Rainbow Six Siege) API wrapper for player stats, operators, maps, ranks, seasons, and game data. Typescript support. Last Updated Y10S3",
   "main": "index.js",
   "module": "index.js",
@@ -19,6 +19,7 @@
     "tsconfig.json",
     "methods/",
     "axiosInstance/",
+    "types/",
     "README.md"
   ],
   "scripts": {

package/types/base-types.d.ts

@@ -0,0 +1,6 @@
+// Base types for r6-data.js
+
+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";

package/types/function-declarations.d.ts

@@ -0,0 +1,40 @@
+// Function declarations for r6-data.js
+
+import {
+  AccountInfoParams,
+  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 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>;

package/types/index.d.ts

@@ -0,0 +1,6 @@
+// Index file for all types - re-exports everything for convenience
+
+export * from './base-types';
+export * from './params-interfaces';
+export * from './result-interfaces';
+export * from './function-declarations';

package/types/params-interfaces.d.ts

@@ -0,0 +1,88 @@
+// Parameter interfaces for r6-data.js
+
+import { PlatformType, PlatformFamily, BoardId, RankVersion } from './base-types';
+
+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 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;
+}

package/types/result-interfaces.d.ts

@@ -0,0 +1,87 @@
+// Result interfaces for r6-data.js
+
+import { PlatformType, PlatformFamily } from './base-types';
+
+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 PlayerComparisonsResult {
+  players: Array<{
+    player: {
+      nameOnPlatform: string;
+      platformType: PlatformType;
+    };
+    stats: any;
+    success: boolean;
+    error?: string;
+  }>;
+  comparison_summary: {
+    field_comparisons: Record<string, {
+      rankings: Array<{
+        player: string;
+        value: number;
+        platform: PlatformType;
+      }>;
+      highest: {
+        player: string;
+        value: number;
+        platform: PlatformType;
+      };
+      lowest: {
+        player: string;
+        value: number;
+        platform: PlatformType;
+      };
+      average: number;
+    }>;
+    rankings: Record<string, any>;
+  };
+  metadata: {
+    total_players: number;
+    successful_fetches: number;
+    failed_fetches: number;
+    platform_families: PlatformFamily;
+    board_id: string;
+    timestamp: string;
+  };
+  errors?: Array<{
+    player: {
+      nameOnPlatform: string;
+      platformType: PlatformType;
+    };
+    error: string;
+  }>;
+}