Documentation

<script src="https://cdn.jsdelivr.net/gh/sevsunday/bz2api.js@1.0.0/bz2api.min.js"></script>

<script src="bz2api.js"></script>

const BZ2API = require('./bz2api.js');

// Basic usage - fetch all sessions
const result = await BZ2API.fetchSessions();
console.log(result.sessions);

// With enrichment options
const enriched = await BZ2API.fetchSessions({
  enrichMaps: true,     // Fetch map images/names
  enrichVsrMaps: true  // Add VSR map metadata
});

// Access session data
enriched.sessions.forEach(session => {
  console.log(session.name, session.state);
  console.log(session.players.map(p => p.name));
});

{
  sessions: Session[],      // Parsed session objects
  timestamp: "ISO string",  // Fetch timestamp
  rawResponse: Object,      // Original API response
  dataCache: Object,        // Consolidated player/mod data
  enrichedMaps: boolean,    // Whether map enrichment was used
  enrichedVsrMaps: boolean  // Whether VSR enrichment was used
}

const raw = await BZ2API.fetchRaw();
console.log(raw.GET); // Array of raw session objects

const mapData = await BZ2API.fetchMapData('rckcnynvsr', '1325933293');
// Returns: { name, description, image, teamNames, modNames }

{
  players: {
    "76561198...": {
      steamId: "76561198...",
      profileUrl: "https://..."
    }
  },
  mods: {
    "1325933293": {
      id: "1325933293",
      name: "Vet Strat Recycler Variant",
      workshopUrl: "https://..."
    }
  }
}

const result = await BZ2API.fetchSessions({
  // Map enrichment (external API calls)
  enrichMaps: true,
  
  // VSR map metadata (built-in data)
  enrichVsrMaps: true,
  
  // Custom VSR data (must specify mode)
  vsrMapData: myCustomData,
  vsrMapDataMode: 'merge',  // or 'replace'
  
  // Custom CORS proxies (browser only)
  corsProxies: [
    'https://myproxy.com/?url='
  ]
});

// Default proxies (used in order)
const CORS_PROXIES = [
  'https://corsproxy.io/?',
  'https://api.allorigins.win/raw?url=',
  'https://api.codetabs.com/v1/proxy?quest='
];

// Override with custom proxies
BZ2API.fetchSessions({
  corsProxies: ['https://my-proxy.com/?url=']
});

const BZ2API = require('./bz2api.js');

(async () => {
  const result = await BZ2API.fetchSessions();
  
  console.log(`Found ${result.sessions.length} sessions`);
  
  result.sessions.forEach(s => {
    console.log(`- ${s.name}: ${s.playerCount} players`);
  });
})();

[Rebellion API] → [Your Server] → [Your Client]
                       ↓
                  [Steam API]

const express = require('express');
const BZ2API = require('./bz2api.js');

const STEAM_API_KEY = process.env.STEAM_API_KEY;

async function getSteamPlayerSummaries(steamIds) {
  if (steamIds.length === 0) return {};
  const url = `https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2/?key=${STEAM_API_KEY}&steamids=${steamIds.join(',')}`;
  const response = await fetch(url);
  const data = await response.json();
  
  const players = {};
  for (const player of data.response.players || []) {
    players[player.steamid] = {
      nickname: player.personaname,
      avatar: player.avatarfull
    };
  }
  return players;
}

const app = express();

app.get('/api/sessions', async (req, res) => {
  try {
    // Fetch and parse sessions
    const result = await BZ2API.fetchSessions({ enrichMaps: true });
    
    // Collect all unique Steam IDs
    const steamIds = new Set();
    for (const session of result.sessions) {
      for (const player of session.players) {
        if (player.steamId) steamIds.add(player.steamId);
      }
    }
    
    // Fetch Steam data in bulk and enrich players
    const steamData = await getSteamPlayerSummaries([...steamIds]);
    for (const session of result.sessions) {
      for (const player of session.players) {
        if (player.steamId && steamData[player.steamId]) {
          Object.assign(player, steamData[player.steamId]);
        }
      }
    }
    
    res.json(result);
  } catch (err) {
    res.status(500).json({ error: err.message });
  }
});

app.listen(3000, () => console.log('Server running'));

const http = require('http');
const BZ2API = require('./bz2api.js');

const STEAM_API_KEY = process.env.STEAM_API_KEY;

async function getSteamPlayerSummaries(steamIds) {
  if (steamIds.length === 0) return {};
  const url = `https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2/?key=${STEAM_API_KEY}&steamids=${steamIds.join(',')}`;
  const response = await fetch(url);
  const data = await response.json();
  
  const players = {};
  for (const player of data.response.players || []) {
    players[player.steamid] = {
      nickname: player.personaname,
      avatar: player.avatarfull
    };
  }
  return players;
}

const server = http.createServer(async (req, res) => {
  if (req.url === '/api/sessions' && req.method === 'GET') {
    try {
      const result = await BZ2API.fetchSessions({ enrichMaps: true });
      
      // Collect and fetch Steam data
      const steamIds = new Set();
      for (const session of result.sessions) {
        for (const player of session.players) {
          if (player.steamId) steamIds.add(player.steamId);
        }
      }
      
      const steamData = await getSteamPlayerSummaries([...steamIds]);
      for (const session of result.sessions) {
        for (const player of session.players) {
          if (player.steamId && steamData[player.steamId]) {
            Object.assign(player, steamData[player.steamId]);
          }
        }
      }
      
      res.writeHead(200, { 'Content-Type': 'application/json' });
      res.end(JSON.stringify(result));
    } catch (err) {
      res.writeHead(500, { 'Content-Type': 'application/json' });
      res.end(JSON.stringify({ error: err.message }));
    }
  } else {
    res.writeHead(404);
    res.end('Not Found');
  }
});

server.listen(3000, () => console.log('Server running'));

BZ2API.API_URL          // Rebellion API endpoint
BZ2API.CORS_PROXIES     // Default proxy list
BZ2API.MAP_API_BASE     // Map assets API base URL
BZ2API.VSR_MOD_ID       // VSR mod Steam ID
BZ2API.VSR_MAP_DATA_RAW // Built-in VSR map data array