@provable-games/budokan-sdk 0.1.0 → 0.1.1

package/dist/react.d.cts

@@ -0,0 +1,160 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { m as BudokanClientConfig, B as BudokanClient, T as Tournament, b as PaginatedResult, e as TournamentListParams, L as LeaderboardEntry, h as PlayerTournament, f as PlayerStats, g as PlayerTournamentParams, c as RewardClaim, d as RewardClaimSummary, k as PrizeStats, a as Prize, Q as QualificationEntry, s as WSEventMessage, r as WSChannel, C as ConnectionMode } from './client-BtC3ngNe.cjs';
+
+interface BudokanProviderProps {
+    children: ReactNode;
+    config?: BudokanClientConfig;
+    client?: BudokanClient;
+}
+/**
+ * Provides a BudokanClient instance to all child components via React context.
+ * Supply either a `config` prop to auto-create a client, or an existing `client` instance.
+ */
+declare function BudokanProvider({ children, config, client: existingClient }: BudokanProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Access the BudokanClient instance from context.
+ * Must be used within a BudokanProvider.
+ */
+declare function useBudokanClient(): BudokanClient;
+
+interface UseTournamentsResult {
+    tournaments: PaginatedResult<Tournament> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch a paginated list of tournaments.
+ */
+declare function useTournaments(params?: TournamentListParams): UseTournamentsResult;
+interface UseTournamentResult {
+    tournament: Tournament | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch a single tournament by ID.
+ */
+declare function useTournament(tournamentId: string | undefined): UseTournamentResult;
+
+interface UseLeaderboardResult {
+    leaderboard: LeaderboardEntry[] | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch the leaderboard for a tournament.
+ */
+declare function useLeaderboard(tournamentId: string | undefined): UseLeaderboardResult;
+
+interface UsePlayerResult {
+    tournaments: PaginatedResult<PlayerTournament> | null;
+    stats: PlayerStats | null;
+    loading: boolean;
+    error: Error | null;
+}
+/**
+ * Hook to fetch a player's tournament history and stats.
+ */
+declare function usePlayer(address: string | undefined): UsePlayerResult;
+interface UsePlayerStatsResult {
+    stats: PlayerStats | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch stats for a player.
+ */
+declare function usePlayerStats(address: string | undefined): UsePlayerStatsResult;
+interface UsePlayerTournamentsResult {
+    tournaments: PaginatedResult<PlayerTournament> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch tournaments a player has registered for.
+ */
+declare function usePlayerTournaments(address: string | undefined, params?: PlayerTournamentParams): UsePlayerTournamentsResult;
+
+interface UseRewardClaimsResult {
+    rewardClaims: PaginatedResult<RewardClaim> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch reward claims for a tournament.
+ */
+declare function useRewardClaims(tournamentId: string | undefined): UseRewardClaimsResult;
+interface UseRewardClaimsSummaryResult {
+    summary: RewardClaimSummary | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch reward claims summary for a tournament.
+ */
+declare function useRewardClaimsSummary(tournamentId: string | undefined): UseRewardClaimsSummaryResult;
+
+interface UsePrizesResult {
+    prizes: Prize[] | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch prizes for a tournament.
+ */
+declare function usePrizes(tournamentId: string | undefined): UsePrizesResult;
+interface UsePrizeStatsResult {
+    prizeStats: PrizeStats | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch platform-wide prize stats.
+ */
+declare function usePrizeStats(): UsePrizeStatsResult;
+
+interface UseQualificationsResult {
+    qualifications: PaginatedResult<QualificationEntry> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch qualification entries for a tournament.
+ */
+declare function useQualifications(tournamentId: string | undefined): UseQualificationsResult;
+
+interface UseSubscriptionResult {
+    lastMessage: WSEventMessage | null;
+    isConnected: boolean;
+}
+/**
+ * Hook to subscribe to WebSocket channels for real-time updates.
+ * Automatically connects and subscribes on mount, and cleans up on unmount.
+ */
+declare function useSubscription(channels: WSChannel[], tournamentIds?: string[]): UseSubscriptionResult;
+
+/**
+ * Hook returning the current WebSocket connection status and datasource mode.
+ *
+ * `datasourceMode` indicates how data is being fetched:
+ * - `"api"` — API is available and being used
+ * - `"rpc-fallback"` — API is down, using direct on-chain RPC calls
+ * - `"offline"` — both API and RPC are unavailable
+ */
+declare function useConnectionStatus(): {
+    isConnected: boolean;
+    datasourceMode: ConnectionMode;
+};
+
+export { BudokanProvider, type BudokanProviderProps, type UseLeaderboardResult, type UsePlayerResult, type UsePlayerStatsResult, type UsePlayerTournamentsResult, type UsePrizeStatsResult, type UsePrizesResult, type UseQualificationsResult, type UseRewardClaimsResult, type UseRewardClaimsSummaryResult, type UseSubscriptionResult, type UseTournamentResult, type UseTournamentsResult, useBudokanClient, useConnectionStatus, useLeaderboard, usePlayer, usePlayerStats, usePlayerTournaments, usePrizeStats, usePrizes, useQualifications, useRewardClaims, useRewardClaimsSummary, useSubscription, useTournament, useTournaments };

package/dist/react.d.ts

@@ -0,0 +1,160 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { m as BudokanClientConfig, B as BudokanClient, T as Tournament, b as PaginatedResult, e as TournamentListParams, L as LeaderboardEntry, h as PlayerTournament, f as PlayerStats, g as PlayerTournamentParams, c as RewardClaim, d as RewardClaimSummary, k as PrizeStats, a as Prize, Q as QualificationEntry, s as WSEventMessage, r as WSChannel, C as ConnectionMode } from './client-BtC3ngNe.js';
+
+interface BudokanProviderProps {
+    children: ReactNode;
+    config?: BudokanClientConfig;
+    client?: BudokanClient;
+}
+/**
+ * Provides a BudokanClient instance to all child components via React context.
+ * Supply either a `config` prop to auto-create a client, or an existing `client` instance.
+ */
+declare function BudokanProvider({ children, config, client: existingClient }: BudokanProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Access the BudokanClient instance from context.
+ * Must be used within a BudokanProvider.
+ */
+declare function useBudokanClient(): BudokanClient;
+
+interface UseTournamentsResult {
+    tournaments: PaginatedResult<Tournament> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch a paginated list of tournaments.
+ */
+declare function useTournaments(params?: TournamentListParams): UseTournamentsResult;
+interface UseTournamentResult {
+    tournament: Tournament | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch a single tournament by ID.
+ */
+declare function useTournament(tournamentId: string | undefined): UseTournamentResult;
+
+interface UseLeaderboardResult {
+    leaderboard: LeaderboardEntry[] | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch the leaderboard for a tournament.
+ */
+declare function useLeaderboard(tournamentId: string | undefined): UseLeaderboardResult;
+
+interface UsePlayerResult {
+    tournaments: PaginatedResult<PlayerTournament> | null;
+    stats: PlayerStats | null;
+    loading: boolean;
+    error: Error | null;
+}
+/**
+ * Hook to fetch a player's tournament history and stats.
+ */
+declare function usePlayer(address: string | undefined): UsePlayerResult;
+interface UsePlayerStatsResult {
+    stats: PlayerStats | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch stats for a player.
+ */
+declare function usePlayerStats(address: string | undefined): UsePlayerStatsResult;
+interface UsePlayerTournamentsResult {
+    tournaments: PaginatedResult<PlayerTournament> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch tournaments a player has registered for.
+ */
+declare function usePlayerTournaments(address: string | undefined, params?: PlayerTournamentParams): UsePlayerTournamentsResult;
+
+interface UseRewardClaimsResult {
+    rewardClaims: PaginatedResult<RewardClaim> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch reward claims for a tournament.
+ */
+declare function useRewardClaims(tournamentId: string | undefined): UseRewardClaimsResult;
+interface UseRewardClaimsSummaryResult {
+    summary: RewardClaimSummary | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch reward claims summary for a tournament.
+ */
+declare function useRewardClaimsSummary(tournamentId: string | undefined): UseRewardClaimsSummaryResult;
+
+interface UsePrizesResult {
+    prizes: Prize[] | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch prizes for a tournament.
+ */
+declare function usePrizes(tournamentId: string | undefined): UsePrizesResult;
+interface UsePrizeStatsResult {
+    prizeStats: PrizeStats | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch platform-wide prize stats.
+ */
+declare function usePrizeStats(): UsePrizeStatsResult;
+
+interface UseQualificationsResult {
+    qualifications: PaginatedResult<QualificationEntry> | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to fetch qualification entries for a tournament.
+ */
+declare function useQualifications(tournamentId: string | undefined): UseQualificationsResult;
+
+interface UseSubscriptionResult {
+    lastMessage: WSEventMessage | null;
+    isConnected: boolean;
+}
+/**
+ * Hook to subscribe to WebSocket channels for real-time updates.
+ * Automatically connects and subscribes on mount, and cleans up on unmount.
+ */
+declare function useSubscription(channels: WSChannel[], tournamentIds?: string[]): UseSubscriptionResult;
+
+/**
+ * Hook returning the current WebSocket connection status and datasource mode.
+ *
+ * `datasourceMode` indicates how data is being fetched:
+ * - `"api"` — API is available and being used
+ * - `"rpc-fallback"` — API is down, using direct on-chain RPC calls
+ * - `"offline"` — both API and RPC are unavailable
+ */
+declare function useConnectionStatus(): {
+    isConnected: boolean;
+    datasourceMode: ConnectionMode;
+};
+
+export { BudokanProvider, type BudokanProviderProps, type UseLeaderboardResult, type UsePlayerResult, type UsePlayerStatsResult, type UsePlayerTournamentsResult, type UsePrizeStatsResult, type UsePrizesResult, type UseQualificationsResult, type UseRewardClaimsResult, type UseRewardClaimsSummaryResult, type UseSubscriptionResult, type UseTournamentResult, type UseTournamentsResult, useBudokanClient, useConnectionStatus, useLeaderboard, usePlayer, usePlayerStats, usePlayerTournaments, usePrizeStats, usePrizes, useQualifications, useRewardClaims, useRewardClaimsSummary, useSubscription, useTournament, useTournaments };