@agg-build/hooks 2.1.0 → 2.1.2

package/dist/index.d.ts

@@ -271,6 +271,12 @@ type VenueMarket = {
     sportsMarketType?: string | null | undefined;
     /** Sort rank within a sports section (0=moneyline, 1=spread, 2=total, 3+=other). */
     sectionRank?: number | null | undefined;
+    /** Period identifier for sports markets (e.g., "1H", "2H", "Q1", etc.). */
+    period?: string | null | undefined;
+    /** Normalized subject category for prop-tab grouping (e.g., game_lines, exact_score, etc.). */
+    marketCategory?: string | null | undefined;
+    /** Line value for spread/total markets (e.g., 2.5 for totals, 3 for spreads). */
+    lineValue?: number | null | undefined;
     matchedVenueMarkets?: {
         id: string;
         venue: Venue;
@@ -324,10 +330,18 @@ type VenueEvent = {
     startDate?: string | null | undefined;
     endDate?: string | null | undefined;
     creationDate?: string | null | undefined;
+    /**
+     * Scheduled kickoff/start of the underlying game (sports events only).
+     * Distinct from `endDate` (market close/expiration), which can sit well
+     * after the game. The FE prefers this over `endDate` for the game-date
+     * title suffix. Null for non-sports events.
+     */
+    gameStartTime?: string | null | undefined;
     slug?: string | null | undefined;
     subtitle?: string | null | undefined;
     venues?: Venue[];
     venueCount?: number | undefined;
+    groupMarketCount?: number | undefined;
     marketCount?: number | undefined;
     /**
      * ISO-8601 duration denormalized from Series.recurrence. `null` means
@@ -676,6 +690,13 @@ interface AggUiLabels {
         categoryTabsAria: string;
     };
     userProfile: {
+        balance: {
+            availableBalance: string;
+            balanceByNetwork: string;
+            paperModeNetwork: string;
+            paperModeWarning: string;
+            networkTooltipDescription: string;
+        };
         activity: {
             depositType: string;
             redeemType: string;
@@ -1080,6 +1101,7 @@ interface AggUiLabels {
         orderSkip: string;
         orderRetryRemaining: string;
         resolvedEarningsTitle: string;
+        resolvedResolutionDateLabel: string;
         resolvedSharesLabel: string;
         resolvedTotalPayoutLabel: string;
         claimWinnings: string;
@@ -1290,6 +1312,7 @@ declare const resolveAggUiLabels: (locale: string) => AggUiLabels;
 
 type ThemeMode = "light" | "dark";
 type ChartTimeRange = "1H" | "6H" | "1D" | "1W" | "1M" | "ALL";
+type AggUiTradingExecutionMode = "live" | "paper";
 interface AggUiGeneralConfig {
     /** Locale for number and date formatting */
     locale: string;
@@ -1376,6 +1399,11 @@ interface AggUiSearchConfig {
     isShowingAllResults: boolean;
 }
 type AggUiSearchConfigInput = Partial<AggUiSearchConfig>;
+interface AggUiTradingConfig {
+    /** Default execution mode used by trading surfaces unless a component prop overrides it. */
+    executionMode: AggUiTradingExecutionMode;
+}
+type AggUiTradingConfigInput = Partial<AggUiTradingConfig>;
 interface AggUiConfig {
     /** Enable AGG development logs */
     enableLogs: boolean;
@@ -1399,6 +1427,8 @@ interface AggUiConfig {
     formatting: AggUiFormattingConfig;
     /** Search configuration */
     search: AggUiSearchConfig;
+    /** Trading configuration */
+    trading: AggUiTradingConfig;
     /**
      * Optional wallet action implementations.
      * When walletActions.sendToken is provided, DepositModal uses it for the
@@ -1432,6 +1462,8 @@ interface AggUiConfigInput {
     formatting?: AggUiFormattingConfigInput;
     /** Search config overrides */
     search?: AggUiSearchConfigInput;
+    /** Trading config overrides */
+    trading?: AggUiTradingConfigInput;
     /**
      * Optional wallet action implementations for deposit flows.
      * Provide this once at the provider level for plug-and-play deposit UX.
@@ -3333,10 +3365,42 @@ declare function useLiveOutcomePrices(venueMarkets: VenueMarket[] | null | undef
  */
 declare function findLivePriceById(livePrices: Map<string, number>, id: string): number | undefined;
 
+interface MarketLiveState {
+    marketId: string;
+    orderbook: OrderbookState | null;
+    orderbookSnapshotVersion: number;
+    orderbookError: string | null;
+    trades: WsTrade[];
+    isConnected: boolean;
+    integrity: "ok" | "resyncing";
+}
+
 type LiveBestPrices = ReadonlyMap<string, {
     bestBid?: number;
     bestAsk?: number;
 }>;
+/**
+ * A WS-derived best-price candidate for one outcome, carrying the venue that
+ * produced each side *and* a freshness stamp. This is the richer companion to
+ * {@link LiveBestPrices}: it keeps the venue attribution that the bare
+ * `{ bestBid, bestAsk }` map throws away, so display surfaces can switch the
+ * venue logo to whichever venue currently owns the best live price — keeping
+ * the logo paired with the price instead of pinned to the REST snapshot.
+ */
+interface LiveBestPriceCandidate {
+    bestBid?: number;
+    bestAsk?: number;
+    /** Venue that owns the cross-venue best bid (best place to sell). */
+    bestBidVenue?: string;
+    /** Venue that owns the cross-venue best ask (cheapest place to buy). */
+    bestAskVenue?: string;
+    midpoint?: number;
+    /** Venue the midpoint is attributed to (cheapest-ask side, then best-bid). */
+    midpointVenue?: string;
+    /** Orderbook timestamp (seconds) of the freshest book backing this candidate. */
+    updatedAt?: number;
+}
+type LiveBestPriceCandidates = ReadonlyMap<string, LiveBestPriceCandidate>;
 /**
  * WS-derived cross-venue + cross-outcome best bid/ask per outcome.
  *
@@ -3364,6 +3428,35 @@ declare function mergeBestPricesPreferringLive(rest: ReadonlyMap<string, {
     bestBid?: number;
     bestAsk?: number;
 }>;
+/**
+ * Pull the per-outcome best bid/ask, attributed venues, midpoint and freshness
+ * out of a single live orderbook state. Pure — exported for unit tests.
+ */
+declare const extractOutcomeBestCandidate: (state: MarketLiveState | undefined) => LiveBestPriceCandidate;
+/**
+ * Cross-venue + cross-outcome venue-attributed best-price candidates.
+ *
+ * Pure (no React) so the cross-venue fold can be unit-tested directly:
+ *   - Pass 1: per-outcome candidate from each outcome's own aggregated book.
+ *   - Pass 2: fold across MVMO groups. Lowest ask wins (cheapest to buy),
+ *     highest bid wins (best to sell), and the *winning venue* + freshest
+ *     timestamp travel with the chosen price to every member of the group.
+ *     This is what lets a different venue's live book switch both the price
+ *     and the venue logo on every WS update.
+ *
+ * Mirrors the price fold in {@link useLiveBestPrices} and the REST fold in
+ * `useMidpoints.extractBestPrices`, but additionally tracks venue + freshness.
+ */
+declare function buildLiveBestPriceCandidates(outcomeIds: string[], states: Array<MarketLiveState | undefined>, venueMarkets: VenueMarket[] | null | undefined): Map<string, LiveBestPriceCandidate>;
+/**
+ * React hook companion to {@link useLiveBestPrices} that additionally carries
+ * venue attribution + freshness per outcome. Recomputes on every WS update
+ * (snapshot/delta) that moves price, venue ownership, or timestamp.
+ *
+ * Empty until WS books land for the subscribed outcomes. Designed to feed a
+ * unified price+venue selector so the venue logo always follows the live price.
+ */
+declare function useLiveBestPriceCandidates(venueMarkets: VenueMarket[] | null | undefined): LiveBestPriceCandidates;
 
 /**
  * Subscribe to real-time trade feed for a canonical market.
@@ -5487,4 +5580,4 @@ declare function useAppConfig(): UseAppConfigResult;
  */
 declare function useCachedAppConfig(): UseAppConfigResult;
 
-export { AUTH_CHOOSER_OPEN_EVENT, type AggAuthContextValue, type AggAuthSignInOptions, type AggBalanceContextValue, AggBalanceProvider, AggProvider, type AggProviderProps, AggProvider as AggSdkProvider, type AggProviderProps as AggSdkProviderProps, type AggUiConfig, type AggUiConfigInput, type AggUiLabels, type AggUiLabelsInput, AggUiProvider, CHART_TIME_RANGES, CONFIRMED_MATCH_STATUSES, type ChartTimeRange, type ClosedPositionTotals, type ComputePriceGapsOptions, DEFAULT_AGG_ROOT_CLASS_NAME, type DagStepProgress, type EventListStateContextValue, EventListStateProvider, type EventListStateSnapshot, type EventTradingContextValue, type EventTradingState, type ExecutionProgressPhase, type ExecutionTerminalOrderEvent, type GeoBlockState, type GetOrdersQuery, type GetPositionsQuery, type InvalidateUserActivityOptions, type InvalidateUserMoneyStateOptions, type LiveBestPrices, type LiveCandle, MAX_PRICE_GAP_PCT, MIN_PRICE_GAP_PCT, type MarketChartCandle, type MarketChartData, type MarketChartVenueData, type MarketOrderbookData, type MarketOrderbookIntegrity, MarketStatus, type MarketTradingState, MatchStatus, MatchType, type OrderEligibility, type OrderEligibilityReason, type OrderListItem, type OrderbookResult, type PositionGroup, type PriceGapValue, type RedeemEvent, type RedeemLegLifecycle, type RedeemLifecycleState, RedeemRejectedError, type RollingChartWindow, type ScaledCandlePoint, type SdkUiConfig, type SdkUiConfigInput, type SdkUiProviderProps, type SmartRouteLoadingReason, type ThemeMode, TradeSide, type TradingAction, type TradingState, type TradingStateBase, type TradingStateKind, type UseAggAuthOptions, type UseAggAuthReturn, type UseAppConfigResult, type UseArbFeedResult, type UseCategoriesOptions, type UseCategoryChildrenOptions, type UseEnrichedVenueEventOptions, type UseExecuteManagedOptions, type UseExecutionOrdersOptions, type UseExecutionPositionsOptions, type UseExecutionProgressOptions, type UseExecutionProgressResult, type UseExternalIdOptions, type UseExternalIdReturn, type UseLinkAccountReturn, type UseLiveCandleOverlayOptions, type UseLiveCandleOverlayResult, type UseLiveCandlesOptions, type UseLiveCandlesResult, type UseLiveMarketResult, type UseMarketArbResult, type UseMarketChartOptions, type UseMarketChartResult, type UseMarketOrderbookOptions, type UseMarketOrderbookResult, type UseMarketOrderbookVenueOutcome, type UseMarketSearchOptions, type UseMidpointsOptions, type UseMidpointsResult, type UseOrderBookOptions, type UseOrderbookQuoteOptions, type UseOrderbookQuoteResult, type UseOrdersOptions, type UsePositionsOptions, type UseQuoteManagedOptions, type UseRedeemLifecycleInput, type UseRollingChartWindowOptions, type UseSearchOptions, type UseSmartRouteOptions, type UseSmartRouteResult, type UseTradableVenuesResult, type UseUserActivityOptions, type UseUserHoldingsOptions, type UseVenueEventOptions, type UseVenueEventsOptions, type UseVenueMarketMidpointsOptions, type UseVenueMarketsOptions, type UseViewportMidpointsOptions, type UseVisibleIdsOptions, type UseVisibleIdsResult, type UserActivityInvalidationStrategy, Venue, type VenueAvailabilityState, type VenueEvent, type VenueEventWithMarkets, type VenueMarket, type VenueMarketOutcome, type WalletActionSendTokenParams, type WalletActions, computeClosedPositionTotals, computePriceGaps, defaultAggUiConfig, defaultAggUiConfig as defaultSdkUiConfig, executionKeys, findLivePriceById, getBuilder, getOrCreateBuilder, getVenueAvailabilityState, getVisibleVenueIdsByConfig, getVisibleVenuesByConfig, getWalletAddressFromUserProfile, invalidateBalanceQueries, invalidatePositionQueries, invalidateUserActivityQueries, invalidateUserClaimState, invalidateUserMoneyState, isVenueDisabledByConfig, mergeBestPricesPreferringLive, normalizeVenueId, optimizedImageUrl, parseEmail, parseEmailStrict, rangeToSeconds, requestAggAuthChooserOpen, resolveAggUiLabels, resolveDefaultMarket as resolveDefaultTradingMarket, resolveEventTradingState, resolveMarketTradingState, resolveMarketWinningOutcome, resolveOrderEligibility, resolveRollingWindow, resolveTradingStateKind, sortVenues, timeRangeToInterval, tradingReducer, useAggAuth, useAggAuthContext, useAggAuthState, useAggBalance, useAggBalanceContext, useAggBalanceState, useAggClient, useAggLabels, useAggUiConfig, useAggWebSocket, useAppConfig, useArbFeed, useCachedAppConfig, useCategories, useCategoryChildren, useDebouncedValue, useEnrichedVenueEvent, useEventListState, useEventOrderbookData, useEventTradingContext, useExecuteManaged, useExecutionOrders, useExecutionPositions, useExecutionProgress, useExternalId, useGeoBlock, useLabels, useLinkAccount, useLiveBestPrices, useLiveCandleOverlay, useLiveCandles, useLiveMarket, useLiveMarketStores, useLiveOutcomePrices, useLiveTrades, useMarketArb, useMarketChart, useMarketOrderbook, useMarketSearch, useMidpoints, useOnBalanceUpdate, useOnOrderEvent, useOnOrderSubmitted, useOnRedeemEvent, useOnWithdrawalLifecycle, useOptionalAggClient, useOrderBook, useOrderbookQuote, useOrders, usePositions, useQuoteManaged, useRampQuotes, useRampSession, useRedeem, useRedeemEligibleCount, useRedeemLifecycle, useRedeemLifecycles, useRollingChartWindow, useSdkLabels, useSdkUiConfig, useSearch, useSmartRoute, useTradableVenues, useUserActivity, useUserHoldings, useVenueEvent, useVenueEvents, useVenueMarketMidpoints, useVenueMarkets, useViewportMidpoints, useVisibleIds, userActivityQueryKeys };
+export { AUTH_CHOOSER_OPEN_EVENT, type AggAuthContextValue, type AggAuthSignInOptions, type AggBalanceContextValue, AggBalanceProvider, AggProvider, type AggProviderProps, AggProvider as AggSdkProvider, type AggProviderProps as AggSdkProviderProps, type AggUiConfig, type AggUiConfigInput, type AggUiLabels, type AggUiLabelsInput, AggUiProvider, type AggUiTradingExecutionMode, CHART_TIME_RANGES, CONFIRMED_MATCH_STATUSES, type ChartTimeRange, type ClosedPositionTotals, type ComputePriceGapsOptions, DEFAULT_AGG_ROOT_CLASS_NAME, type DagStepProgress, type EventListStateContextValue, EventListStateProvider, type EventListStateSnapshot, type EventTradingContextValue, type EventTradingState, type ExecutionProgressPhase, type ExecutionTerminalOrderEvent, type GeoBlockState, type GetOrdersQuery, type GetPositionsQuery, type InvalidateUserActivityOptions, type InvalidateUserMoneyStateOptions, type LiveBestPriceCandidate, type LiveBestPriceCandidates, type LiveBestPrices, type LiveCandle, MAX_PRICE_GAP_PCT, MIN_PRICE_GAP_PCT, type MarketChartCandle, type MarketChartData, type MarketChartVenueData, type MarketOrderbookData, type MarketOrderbookIntegrity, MarketStatus, type MarketTradingState, MatchStatus, MatchType, type OrderEligibility, type OrderEligibilityReason, type OrderListItem, type OrderbookResult, type PositionGroup, type PriceGapValue, type RedeemEvent, type RedeemLegLifecycle, type RedeemLifecycleState, RedeemRejectedError, type RollingChartWindow, type ScaledCandlePoint, type SdkUiConfig, type SdkUiConfigInput, type SdkUiProviderProps, type SmartRouteLoadingReason, type ThemeMode, TradeSide, type TradingAction, type TradingState, type TradingStateBase, type TradingStateKind, type UseAggAuthOptions, type UseAggAuthReturn, type UseAppConfigResult, type UseArbFeedResult, type UseCategoriesOptions, type UseCategoryChildrenOptions, type UseEnrichedVenueEventOptions, type UseExecuteManagedOptions, type UseExecutionOrdersOptions, type UseExecutionPositionsOptions, type UseExecutionProgressOptions, type UseExecutionProgressResult, type UseExternalIdOptions, type UseExternalIdReturn, type UseLinkAccountReturn, type UseLiveCandleOverlayOptions, type UseLiveCandleOverlayResult, type UseLiveCandlesOptions, type UseLiveCandlesResult, type UseLiveMarketResult, type UseMarketArbResult, type UseMarketChartOptions, type UseMarketChartResult, type UseMarketOrderbookOptions, type UseMarketOrderbookResult, type UseMarketOrderbookVenueOutcome, type UseMarketSearchOptions, type UseMidpointsOptions, type UseMidpointsResult, type UseOrderBookOptions, type UseOrderbookQuoteOptions, type UseOrderbookQuoteResult, type UseOrdersOptions, type UsePositionsOptions, type UseQuoteManagedOptions, type UseRedeemLifecycleInput, type UseRollingChartWindowOptions, type UseSearchOptions, type UseSmartRouteOptions, type UseSmartRouteResult, type UseTradableVenuesResult, type UseUserActivityOptions, type UseUserHoldingsOptions, type UseVenueEventOptions, type UseVenueEventsOptions, type UseVenueMarketMidpointsOptions, type UseVenueMarketsOptions, type UseViewportMidpointsOptions, type UseVisibleIdsOptions, type UseVisibleIdsResult, type UserActivityInvalidationStrategy, Venue, type VenueAvailabilityState, type VenueEvent, type VenueEventWithMarkets, type VenueMarket, type VenueMarketOutcome, type WalletActionSendTokenParams, type WalletActions, buildLiveBestPriceCandidates, computeClosedPositionTotals, computePriceGaps, defaultAggUiConfig, defaultAggUiConfig as defaultSdkUiConfig, executionKeys, extractOutcomeBestCandidate, findLivePriceById, getBuilder, getOrCreateBuilder, getVenueAvailabilityState, getVisibleVenueIdsByConfig, getVisibleVenuesByConfig, getWalletAddressFromUserProfile, invalidateBalanceQueries, invalidatePositionQueries, invalidateUserActivityQueries, invalidateUserClaimState, invalidateUserMoneyState, isVenueDisabledByConfig, mergeBestPricesPreferringLive, normalizeVenueId, optimizedImageUrl, parseEmail, parseEmailStrict, rangeToSeconds, requestAggAuthChooserOpen, resolveAggUiLabels, resolveDefaultMarket as resolveDefaultTradingMarket, resolveEventTradingState, resolveMarketTradingState, resolveMarketWinningOutcome, resolveOrderEligibility, resolveRollingWindow, resolveTradingStateKind, sortVenues, timeRangeToInterval, tradingReducer, useAggAuth, useAggAuthContext, useAggAuthState, useAggBalance, useAggBalanceContext, useAggBalanceState, useAggClient, useAggLabels, useAggUiConfig, useAggWebSocket, useAppConfig, useArbFeed, useCachedAppConfig, useCategories, useCategoryChildren, useDebouncedValue, useEnrichedVenueEvent, useEventListState, useEventOrderbookData, useEventTradingContext, useExecuteManaged, useExecutionOrders, useExecutionPositions, useExecutionProgress, useExternalId, useGeoBlock, useLabels, useLinkAccount, useLiveBestPriceCandidates, useLiveBestPrices, useLiveCandleOverlay, useLiveCandles, useLiveMarket, useLiveMarketStores, useLiveOutcomePrices, useLiveTrades, useMarketArb, useMarketChart, useMarketOrderbook, useMarketSearch, useMidpoints, useOnBalanceUpdate, useOnOrderEvent, useOnOrderSubmitted, useOnRedeemEvent, useOnWithdrawalLifecycle, useOptionalAggClient, useOrderBook, useOrderbookQuote, useOrders, usePositions, useQuoteManaged, useRampQuotes, useRampSession, useRedeem, useRedeemEligibleCount, useRedeemLifecycle, useRedeemLifecycles, useRollingChartWindow, useSdkLabels, useSdkUiConfig, useSearch, useSmartRoute, useTradableVenues, useUserActivity, useUserHoldings, useVenueEvent, useVenueEvents, useVenueMarketMidpoints, useVenueMarkets, useViewportMidpoints, useVisibleIds, userActivityQueryKeys };