@provable-games/budokan-sdk 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -0,0 +1,205 @@
+import { T as Tournament, L as LeaderboardEntry, P as PrizeAggregation, a as Prize, b as PaginatedResult, Q as QualificationEntry, R as Registration, c as RewardClaim, d as RewardClaimSummary, e as TournamentListParams, f as PlayerStats, g as PlayerTournamentParams, h as PlayerTournament, i as PlatformStats, A as ActivityParams, j as ActivityEvent, k as PrizeStats, W as WSSubscribeOptions, l as WSEventHandler } from './client-BtC3ngNe.js';
+export { B as BudokanClient, m as BudokanClientConfig, C as ConnectionMode, n as ConnectionStatus, o as ConnectionStatusState, D as DataSource, E as EntryFee, G as GameConfig, p as LeaderboardConfig, q as Phase, S as Schedule, r as WSChannel, s as WSEventMessage, t as WSMessage, u as WSSubscribeMessage, v as WSUnsubscribeMessage, w as createBudokanClient } from './client-BtC3ngNe.js';
+
+declare class BudokanError extends Error {
+    constructor(message: string);
+}
+declare class BudokanApiError extends BudokanError {
+    readonly status: number;
+    readonly statusText: string;
+    constructor(message: string, status: number, statusText?: string);
+}
+declare class BudokanTimeoutError extends BudokanError {
+    constructor(message?: string);
+}
+declare class BudokanConnectionError extends BudokanError {
+    constructor(message?: string);
+}
+declare class TournamentNotFoundError extends BudokanError {
+    readonly tournamentId: string;
+    constructor(tournamentId: string);
+}
+declare class RpcError extends BudokanError {
+    readonly contractAddress?: string;
+    constructor(message: string, contractAddress?: string);
+}
+declare class DataSourceError extends BudokanError {
+    readonly primaryError: Error;
+    readonly fallbackError: Error;
+    constructor(primaryError: Error, fallbackError: Error);
+}
+
+interface ApiContext$3 {
+    retryAttempts?: number;
+    retryDelay?: number;
+    timeout?: number;
+}
+/**
+ * Fetch a paginated list of tournaments.
+ */
+declare function getTournaments(baseUrl: string, params?: TournamentListParams, ctx?: ApiContext$3): Promise<PaginatedResult<Tournament>>;
+/**
+ * Fetch a single tournament by ID.
+ */
+declare function getTournament(baseUrl: string, tournamentId: string, ctx?: ApiContext$3): Promise<Tournament>;
+/**
+ * Fetch the leaderboard for a tournament.
+ */
+declare function getTournamentLeaderboard(baseUrl: string, tournamentId: string, ctx?: ApiContext$3): Promise<LeaderboardEntry[]>;
+/**
+ * Fetch registrations for a tournament.
+ */
+declare function getTournamentRegistrations(baseUrl: string, tournamentId: string, params?: {
+    limit?: number;
+    offset?: number;
+}, ctx?: ApiContext$3): Promise<PaginatedResult<Registration>>;
+/**
+ * Fetch prizes for a tournament.
+ */
+declare function getTournamentPrizes(baseUrl: string, tournamentId: string, ctx?: ApiContext$3): Promise<Prize[]>;
+/**
+ * Fetch reward claims for a tournament.
+ */
+declare function getTournamentRewardClaims(baseUrl: string, tournamentId: string, params?: {
+    limit?: number;
+    offset?: number;
+}, ctx?: ApiContext$3): Promise<PaginatedResult<RewardClaim>>;
+/**
+ * Fetch reward claims summary for a tournament.
+ */
+declare function getTournamentRewardClaimsSummary(baseUrl: string, tournamentId: string, ctx?: ApiContext$3): Promise<RewardClaimSummary>;
+/**
+ * Fetch qualifications for a tournament.
+ */
+declare function getTournamentQualifications(baseUrl: string, tournamentId: string, params?: {
+    limit?: number;
+    offset?: number;
+}, ctx?: ApiContext$3): Promise<PaginatedResult<QualificationEntry>>;
+/**
+ * Fetch prize aggregation for a tournament.
+ */
+declare function getTournamentPrizeAggregation(baseUrl: string, tournamentId: string, ctx?: ApiContext$3): Promise<PrizeAggregation[]>;
+
+interface ApiContext$2 {
+    retryAttempts?: number;
+    retryDelay?: number;
+    timeout?: number;
+}
+/**
+ * Fetch tournaments for a player.
+ */
+declare function getPlayerTournaments(baseUrl: string, address: string, params?: PlayerTournamentParams, ctx?: ApiContext$2): Promise<PaginatedResult<PlayerTournament>>;
+/**
+ * Fetch stats for a player.
+ */
+declare function getPlayerStats(baseUrl: string, address: string, ctx?: ApiContext$2): Promise<PlayerStats>;
+
+interface ApiContext$1 {
+    retryAttempts?: number;
+    retryDelay?: number;
+    timeout?: number;
+}
+/**
+ * Fetch tournaments for a specific game.
+ */
+declare function getGameTournaments(baseUrl: string, gameAddress: string, params?: Omit<TournamentListParams, "gameAddress">, ctx?: ApiContext$1): Promise<PaginatedResult<Tournament>>;
+/**
+ * Fetch tournament stats for a specific game.
+ */
+declare function getGameStats(baseUrl: string, gameAddress: string, ctx?: ApiContext$1): Promise<PlatformStats>;
+
+interface ApiContext {
+    retryAttempts?: number;
+    retryDelay?: number;
+    timeout?: number;
+}
+/**
+ * Fetch activity events with optional filtering.
+ */
+declare function getActivity(baseUrl: string, params?: ActivityParams, ctx?: ApiContext): Promise<PaginatedResult<ActivityEvent>>;
+/**
+ * Fetch platform-wide activity stats.
+ */
+declare function getActivityStats(baseUrl: string, ctx?: ApiContext): Promise<PlatformStats>;
+/**
+ * Fetch platform-wide prize stats.
+ */
+declare function getPrizeStats(baseUrl: string, ctx?: ApiContext): Promise<PrizeStats>;
+
+interface WSManagerConfig {
+    maxReconnectAttempts: number;
+    reconnectBaseDelay: number;
+}
+/**
+ * WebSocket manager with auto-reconnect and subscription management.
+ */
+declare class WSManager {
+    private ws;
+    private readonly wsUrl;
+    private readonly config;
+    private reconnectAttempts;
+    private reconnectTimeout;
+    private subscriptions;
+    private nextSubId;
+    private connected;
+    private connectionListeners;
+    constructor(wsUrl: string, config?: Partial<WSManagerConfig>);
+    /**
+     * Open a WebSocket connection. No-op if already connected.
+     */
+    connect(): void;
+    /**
+     * Close the WebSocket connection and stop reconnecting.
+     */
+    disconnect(): void;
+    /**
+     * Subscribe to channels with an optional tournament filter.
+     * Returns an unsubscribe function.
+     */
+    subscribe(options: WSSubscribeOptions, handler: WSEventHandler): () => void;
+    /**
+     * Register a callback for a single message. Convenience wrapper around subscribe.
+     * Returns an unsubscribe function.
+     */
+    onMessage(callback: WSEventHandler): () => void;
+    /**
+     * Whether the WebSocket is currently connected.
+     */
+    get isConnected(): boolean;
+    /**
+     * Register a listener for connection state changes.
+     * Returns an unsubscribe function.
+     */
+    onConnectionChange(listener: (connected: boolean) => void): () => void;
+    private notifyConnectionChange;
+    private sendSubscribe;
+    private attemptReconnect;
+}
+
+/**
+ * Normalize a Starknet address to a 0x-prefixed, 66-character lowercase hex string.
+ */
+declare function normalizeAddress(address: string): string;
+
+/**
+ * Deeply convert all keys in an object from snake_case to camelCase.
+ */
+declare function snakeToCamel<T>(obj: unknown): T;
+/**
+ * Deeply convert all keys in an object from camelCase to snake_case.
+ */
+declare function camelToSnake<T>(obj: unknown): T;
+
+declare function withRetry<T>(fn: () => Promise<T>, attempts?: number, delay?: number): Promise<T>;
+
+interface ChainConfig {
+    rpcUrl: string;
+    apiBaseUrl: string;
+    wsUrl: string;
+    budokanAddress: string;
+    viewerAddress: string;
+}
+declare const CHAINS: Record<string, ChainConfig>;
+declare function getChainConfig(chain: string): ChainConfig | undefined;
+
+export { ActivityEvent, ActivityParams, BudokanApiError, BudokanConnectionError, BudokanError, BudokanTimeoutError, CHAINS, type ChainConfig, DataSourceError, LeaderboardEntry, PaginatedResult, PlatformStats, PlayerStats, PlayerTournament, PlayerTournamentParams, Prize, PrizeAggregation, PrizeStats, QualificationEntry, Registration, RewardClaim, RewardClaimSummary, RpcError, Tournament, TournamentListParams, TournamentNotFoundError, WSEventHandler, WSManager, WSSubscribeOptions, camelToSnake, getActivity, getActivityStats, getChainConfig, getGameStats, getGameTournaments, getPlayerStats, getPlayerTournaments, getPrizeStats, getTournament, getTournamentLeaderboard, getTournamentPrizeAggregation, getTournamentPrizes, getTournamentQualifications, getTournamentRegistrations, getTournamentRewardClaims, getTournamentRewardClaimsSummary, getTournaments, normalizeAddress, snakeToCamel, withRetry };