@liberfi.io/ui-predict 1.0.0 → 1.0.2

package/dist/index.d.mts

@@ -13,7 +13,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.0.0";
+declare const _default: "1.0.2";
 
 /**
  * A single category entry in the static navigation model.
@@ -132,8 +132,14 @@ interface EventsPageProps {
     onHover?: (event: PredictEvent) => void;
     /** Optional background image for the Hero area. */
     bgImageSrc?: string;
+    /**
+     * Forwarded to the underlying trade modal: invoked when the user attempts
+     * to buy with an amount exceeding the available USDC balance for the
+     * market's source. Use this to open a Fund Wallet / deposit flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function EventsPage({ onSelect, onSelectOutcome, getEventHref, LinkComponent, onHover, bgImageSrc: _bgImageSrc, }: EventsPageProps): react_jsx_runtime.JSX.Element;
+declare function EventsPage({ onSelect, onSelectOutcome, getEventHref, LinkComponent, onHover, bgImageSrc: _bgImageSrc, onInsufficientBalance, }: EventsPageProps): react_jsx_runtime.JSX.Element;
 
 interface EventsWidgetProps {
     /** Category / tag selection from the categories widget. */
@@ -258,8 +264,15 @@ interface EventDetailPageProps {
         event: PredictEvent;
         walletAddress?: string;
     }) => React.ReactNode;
+    /**
+     * Forwarded to the inline TradeFormWidget and the mobile trade modal:
+     * invoked when the user attempts to buy with an amount exceeding the
+     * available USDC balance for the market's source. Use this to open a Fund
+     * Wallet / deposit flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
+declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, onInsufficientBalance, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
 
 type TradeOutcome = "yes" | "no";
 type TradeSide = "buy" | "sell";
@@ -301,6 +314,14 @@ interface UseTradeFormParams {
     market: PredictMarket;
     chain?: string;
     initialOutcome?: TradeOutcome;
+    /**
+     * Callback fired when the user attempts to submit a buy with an amount
+     * larger than the available USDC balance for the market's source. The
+     * consumer typically uses this to open a "Fund wallet" / Deposit flow.
+     * The callback is invoked BEFORE the inline validation errors are shown,
+     * giving the consumer a chance to redirect the user to a top-up flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
 interface UseTradeFormResult {
     outcome: TradeOutcome;
@@ -316,6 +337,10 @@ interface UseTradeFormResult {
     isMarketDataLoading: boolean;
     isSubmitting: boolean;
     validation: TradeFormValidation;
+    /** True when the user has entered an amount that exceeds the available USDC balance. */
+    isInsufficientBalance: boolean;
+    /** The provider source for this market, useful to map to the right wallet. */
+    source: ProviderSource;
     supportsLimitOrder: boolean;
     kycRequired: boolean;
     kycUrl: string | null;
@@ -332,8 +357,14 @@ interface UseTradeFormResult {
     setCustomDuration: (v: number) => void;
     setCustomDurationUnit: (u: DurationUnit) => void;
     submit: () => void;
+    /**
+     * Notify the consumer about an insufficient-balance attempt. The hook
+     * forwards the configured `onInsufficientBalance` callback (if any) so the
+     * UI layer can call it without re-threading the option from the consumer.
+     */
+    notifyInsufficientBalance: () => void;
 }
-declare function useTradeForm({ market, initialOutcome, }: UseTradeFormParams): UseTradeFormResult;
+declare function useTradeForm({ market, initialOutcome, onInsufficientBalance, }: UseTradeFormParams): UseTradeFormResult;
 
 interface EventDetailUIProps {
     event: PredictEvent;
@@ -455,6 +486,11 @@ type PredictTradeModalParams = {
     market: PredictMarket;
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Called when the user presses Buy with insufficient USDC balance for the
+     * market's source. Allows the consumer to open a Fund Wallet flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 };
 type PredictTradeModalResult = void;
 declare const PREDICT_TRADE_MODAL_ID = "predict-trade";
@@ -498,6 +534,10 @@ interface TradeFormUIProps {
     isBalanceLoading: boolean;
     isValid: boolean;
     validationErrors: string[];
+    /** When true, pressing submit triggers the insufficient-balance handler (e.g. open Fund Wallet) instead of showing inline errors. */
+    isInsufficientBalance: boolean;
+    /** Invoked when the user presses submit while balance is insufficient. */
+    onInsufficientBalance?: () => void;
     supportsLimitOrder: boolean;
     kycRequired: boolean;
     kycUrl: string | null;
@@ -515,7 +555,7 @@ interface TradeFormUIProps {
     onCustomDurationUnitChange: (u: DurationUnit) => void;
     onSubmit: () => void;
 }
-declare function TradeFormUI({ event, market, variant, outcome, orderType, quantity, limitPrice, shares, potentialProfit, potentialPayout, estimatedCost, usdcBalance, isBalanceLoading, isMarketDataLoading, isSubmitting, isValid, validationErrors, supportsLimitOrder, kycRequired, kycUrl, expirationEnabled, expirationPreset, customDuration, customDurationUnit, onOutcomeChange, onOrderTypeChange, onQuantityChange, onLimitPriceChange, onExpirationEnabledChange, onExpirationPresetChange, onCustomDurationChange, onCustomDurationUnitChange, onSubmit, }: TradeFormUIProps): react_jsx_runtime.JSX.Element;
+declare function TradeFormUI({ event, market, variant, outcome, orderType, quantity, limitPrice, shares, potentialProfit, potentialPayout, estimatedCost, usdcBalance, isBalanceLoading, isMarketDataLoading, isSubmitting, isValid, validationErrors, isInsufficientBalance, onInsufficientBalance, supportsLimitOrder, kycRequired, kycUrl, expirationEnabled, expirationPreset, customDuration, customDurationUnit, onOutcomeChange, onOrderTypeChange, onQuantityChange, onLimitPriceChange, onExpirationEnabledChange, onExpirationPresetChange, onCustomDurationChange, onCustomDurationUnitChange, onSubmit, }: TradeFormUIProps): react_jsx_runtime.JSX.Element;
 
 interface TradeFormWidgetProps {
     event?: PredictEvent;
@@ -523,8 +563,14 @@ interface TradeFormWidgetProps {
     variant?: "bordered" | "flat";
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Called when the user presses Buy with an amount larger than the available
+     * USDC balance for the market's source. Use this to show a top-up flow
+     * (e.g. open a Fund Wallet modal pre-selected for the right chain).
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
+declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, onInsufficientBalance, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
 
 type PredictSellModalParams = {
     event: PredictEvent;

package/dist/index.d.ts

@@ -13,7 +13,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.0.0";
+declare const _default: "1.0.2";
 
 /**
  * A single category entry in the static navigation model.
@@ -132,8 +132,14 @@ interface EventsPageProps {
     onHover?: (event: PredictEvent) => void;
     /** Optional background image for the Hero area. */
     bgImageSrc?: string;
+    /**
+     * Forwarded to the underlying trade modal: invoked when the user attempts
+     * to buy with an amount exceeding the available USDC balance for the
+     * market's source. Use this to open a Fund Wallet / deposit flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function EventsPage({ onSelect, onSelectOutcome, getEventHref, LinkComponent, onHover, bgImageSrc: _bgImageSrc, }: EventsPageProps): react_jsx_runtime.JSX.Element;
+declare function EventsPage({ onSelect, onSelectOutcome, getEventHref, LinkComponent, onHover, bgImageSrc: _bgImageSrc, onInsufficientBalance, }: EventsPageProps): react_jsx_runtime.JSX.Element;
 
 interface EventsWidgetProps {
     /** Category / tag selection from the categories widget. */
@@ -258,8 +264,15 @@ interface EventDetailPageProps {
         event: PredictEvent;
         walletAddress?: string;
     }) => React.ReactNode;
+    /**
+     * Forwarded to the inline TradeFormWidget and the mobile trade modal:
+     * invoked when the user attempts to buy with an amount exceeding the
+     * available USDC balance for the market's source. Use this to open a Fund
+     * Wallet / deposit flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
+declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, onInsufficientBalance, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
 
 type TradeOutcome = "yes" | "no";
 type TradeSide = "buy" | "sell";
@@ -301,6 +314,14 @@ interface UseTradeFormParams {
     market: PredictMarket;
     chain?: string;
     initialOutcome?: TradeOutcome;
+    /**
+     * Callback fired when the user attempts to submit a buy with an amount
+     * larger than the available USDC balance for the market's source. The
+     * consumer typically uses this to open a "Fund wallet" / Deposit flow.
+     * The callback is invoked BEFORE the inline validation errors are shown,
+     * giving the consumer a chance to redirect the user to a top-up flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
 interface UseTradeFormResult {
     outcome: TradeOutcome;
@@ -316,6 +337,10 @@ interface UseTradeFormResult {
     isMarketDataLoading: boolean;
     isSubmitting: boolean;
     validation: TradeFormValidation;
+    /** True when the user has entered an amount that exceeds the available USDC balance. */
+    isInsufficientBalance: boolean;
+    /** The provider source for this market, useful to map to the right wallet. */
+    source: ProviderSource;
     supportsLimitOrder: boolean;
     kycRequired: boolean;
     kycUrl: string | null;
@@ -332,8 +357,14 @@ interface UseTradeFormResult {
     setCustomDuration: (v: number) => void;
     setCustomDurationUnit: (u: DurationUnit) => void;
     submit: () => void;
+    /**
+     * Notify the consumer about an insufficient-balance attempt. The hook
+     * forwards the configured `onInsufficientBalance` callback (if any) so the
+     * UI layer can call it without re-threading the option from the consumer.
+     */
+    notifyInsufficientBalance: () => void;
 }
-declare function useTradeForm({ market, initialOutcome, }: UseTradeFormParams): UseTradeFormResult;
+declare function useTradeForm({ market, initialOutcome, onInsufficientBalance, }: UseTradeFormParams): UseTradeFormResult;
 
 interface EventDetailUIProps {
     event: PredictEvent;
@@ -455,6 +486,11 @@ type PredictTradeModalParams = {
     market: PredictMarket;
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Called when the user presses Buy with insufficient USDC balance for the
+     * market's source. Allows the consumer to open a Fund Wallet flow.
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 };
 type PredictTradeModalResult = void;
 declare const PREDICT_TRADE_MODAL_ID = "predict-trade";
@@ -498,6 +534,10 @@ interface TradeFormUIProps {
     isBalanceLoading: boolean;
     isValid: boolean;
     validationErrors: string[];
+    /** When true, pressing submit triggers the insufficient-balance handler (e.g. open Fund Wallet) instead of showing inline errors. */
+    isInsufficientBalance: boolean;
+    /** Invoked when the user presses submit while balance is insufficient. */
+    onInsufficientBalance?: () => void;
     supportsLimitOrder: boolean;
     kycRequired: boolean;
     kycUrl: string | null;
@@ -515,7 +555,7 @@ interface TradeFormUIProps {
     onCustomDurationUnitChange: (u: DurationUnit) => void;
     onSubmit: () => void;
 }
-declare function TradeFormUI({ event, market, variant, outcome, orderType, quantity, limitPrice, shares, potentialProfit, potentialPayout, estimatedCost, usdcBalance, isBalanceLoading, isMarketDataLoading, isSubmitting, isValid, validationErrors, supportsLimitOrder, kycRequired, kycUrl, expirationEnabled, expirationPreset, customDuration, customDurationUnit, onOutcomeChange, onOrderTypeChange, onQuantityChange, onLimitPriceChange, onExpirationEnabledChange, onExpirationPresetChange, onCustomDurationChange, onCustomDurationUnitChange, onSubmit, }: TradeFormUIProps): react_jsx_runtime.JSX.Element;
+declare function TradeFormUI({ event, market, variant, outcome, orderType, quantity, limitPrice, shares, potentialProfit, potentialPayout, estimatedCost, usdcBalance, isBalanceLoading, isMarketDataLoading, isSubmitting, isValid, validationErrors, isInsufficientBalance, onInsufficientBalance, supportsLimitOrder, kycRequired, kycUrl, expirationEnabled, expirationPreset, customDuration, customDurationUnit, onOutcomeChange, onOrderTypeChange, onQuantityChange, onLimitPriceChange, onExpirationEnabledChange, onExpirationPresetChange, onCustomDurationChange, onCustomDurationUnitChange, onSubmit, }: TradeFormUIProps): react_jsx_runtime.JSX.Element;
 
 interface TradeFormWidgetProps {
     event?: PredictEvent;
@@ -523,8 +563,14 @@ interface TradeFormWidgetProps {
     variant?: "bordered" | "flat";
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Called when the user presses Buy with an amount larger than the available
+     * USDC balance for the market's source. Use this to show a top-up flow
+     * (e.g. open a Fund Wallet modal pre-selected for the right chain).
+     */
+    onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
+declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, onInsufficientBalance, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
 
 type PredictSellModalParams = {
     event: PredictEvent;