@pear-protocol/symmio-client 0.1.6 → 0.1.8

package/dist/react/index.d.mts

@@ -445,11 +445,39 @@ declare function useSymmAuth(): {
     refresh: (accountAddress?: viem.Address) => Promise<string | null>;
 };
 
+/**
+ * Consumer-facing query configuration.
+ * Allows overriding common TanStack Query options without
+ * affecting the hook's internal queryKey/queryFn/select.
+ */
+type SymmQueryConfig = {
+    /** Whether the query should execute. ANDed with the hook's internal conditions. */
+    enabled?: boolean;
+    /** Time in ms that data is considered fresh. Overrides the hook's default. */
+    staleTime?: number;
+    /** Time in ms that unused/inactive cache data remains in memory. */
+    gcTime?: number;
+    /** Polling interval in ms, or false to disable. */
+    refetchInterval?: number | false;
+    /** Refetch when the window regains focus. */
+    refetchOnWindowFocus?: boolean | 'always';
+    /** Refetch when the component mounts. */
+    refetchOnMount?: boolean | 'always';
+    /** Refetch when the network reconnects. */
+    refetchOnReconnect?: boolean | 'always';
+    /** Number of retry attempts on failure, or false to disable. */
+    retry?: boolean | number;
+    /** Delay between retries in ms, or a function of attempt index. */
+    retryDelay?: number | ((attemptIndex: number) => number);
+};
+
 type UseSymmDelegationParams = {
     accountAddress?: Address;
     target?: Address;
     selectors?: readonly Hex[];
+    /** @deprecated Use `query.enabled` instead. */
     enabled?: boolean;
+    query?: SymmQueryConfig;
 };
 type SymmDelegationState = {
     hasAccess: boolean;
@@ -494,7 +522,9 @@ declare function useSymmInstantTrade(params?: {
     execute: _tanstack_react_query.UseMutationResult<unknown, Error, SymmInstantTradeRequest, unknown>;
 };
 
-declare function useSymmAccounts(userAddress?: Address): {
+declare function useSymmAccounts(userAddress?: Address, options?: {
+    query?: SymmQueryConfig;
+}): {
     accounts: Account[];
     count: number;
     isLoading: boolean;
@@ -514,6 +544,7 @@ declare function useSymmApproval(params: {
     amount: bigint;
     spender?: Address;
     collateralToken?: Address;
+    query?: SymmQueryConfig;
 }): {
     approvalState: ApprovalState | null;
     allowance: bigint;
@@ -555,7 +586,9 @@ declare function useSymmCollateral(): {
     }, unknown>;
 };
 
-declare function useSymmSignature(userAddress?: Address): {
+declare function useSymmSignature(userAddress?: Address, options?: {
+    query?: SymmQueryConfig;
+}): {
     hasSigned: boolean;
     isLoading: boolean;
     signTerms: _tanstack_react_query.UseMutationResult<void, Error, void, unknown>;
@@ -564,6 +597,7 @@ declare function useSymmSignature(userAddress?: Address): {
 declare function useSymmAvailableMargin(params: {
     accountAddress?: Address;
     upnl?: bigint;
+    query?: SymmQueryConfig;
 }): {
     availableForOrder: bigint | null;
     stats: {
@@ -609,6 +643,7 @@ declare function useSymmBalances(params: {
     userAddress?: Address;
     chainId?: number;
     multiAccountAddress?: Address;
+    query?: SymmQueryConfig;
 }): {
     balanceInfo: node_modules__pear_protocol_symm_core_dist_types.BalanceInfoResponse | null;
     isLoading: boolean;
@@ -632,6 +667,7 @@ declare function useSymmPositions(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     positions: _pear_protocol_symm_core.OpenPositionDto[];
     isLoading: boolean;
@@ -642,6 +678,7 @@ declare function useSymmOpenOrders(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     orders: _pear_protocol_symm_core.UnifiedOrderItem[];
     isLoading: boolean;
@@ -652,6 +689,7 @@ declare function useSymmTradeHistory(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     trades: _pear_protocol_symm_shared.ApiResponse<unknown> | null;
     isLoading: boolean;
@@ -667,6 +705,7 @@ declare function useSymmTwap(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     twapOrders: node_modules__pear_protocol_symm_core_dist_types.TwapOrder[];
     isLoading: boolean;
@@ -676,6 +715,7 @@ declare function useSymmTwap(params: {
 declare function useSymmMarkets(params?: {
     chainId?: number;
     searchText?: string;
+    query?: SymmQueryConfig;
 }): {
     markets: _pear_protocol_symm_core.MarketGroupItem[];
     isLoading: boolean;
@@ -683,7 +723,9 @@ declare function useSymmMarkets(params?: {
 };
 
 type UseSymmHedgerMarketsParams = GetSymmHedgerMarketsRequest & {
+    /** @deprecated Use `query.enabled` instead. */
     enabled?: boolean;
+    query?: SymmQueryConfig;
 };
 declare function useSymmHedgerMarkets(params?: UseSymmHedgerMarketsParams): {
     data: _pear_protocol_symm_core.SymmHedgerMarketsResult | null;
@@ -703,6 +745,7 @@ declare function useSymmHedgerMarkets(params?: UseSymmHedgerMarketsParams): {
 
 declare function useSymmFunding(params?: {
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     rates: node_modules__pear_protocol_symm_core_dist_types.FundingRate[];
     isLoading: boolean;
@@ -712,6 +755,7 @@ declare function useSymmPortfolio(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     metrics: _pear_protocol_symm_core.PortfolioResponse | null;
     isLoading: boolean;
@@ -721,6 +765,7 @@ declare function useSymmPortfolio(params: {
 declare function useSymmNotifications(params: {
     userAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     notifications: _pear_protocol_symm_core.Notification[];
     unreadCount: number;
@@ -792,7 +837,10 @@ interface UseSymmTokenSelectionMetadataReturn {
  * Fetches Binance market data for selected SYMM chart tokens and derives
  * chart header metrics (price ratio, weighted ratio, etc.).
  */
-declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection): UseSymmTokenSelectionMetadataReturn;
+declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection, options?: {
+    enabled?: boolean;
+    query?: SymmQueryConfig;
+}): UseSymmTokenSelectionMetadataReturn;
 
 /**
  * Candle interval type matching the chart system.
@@ -855,7 +903,7 @@ interface SymmPerformanceOverlay {
  */
 declare function useSymmPerformanceOverlays(selection: SymmChartSelection): {
     overlays: SymmPerformanceOverlay[];
-    generateOverlaySymbols: () => string[];
+    overlaySymbols: string[];
 };
 
 declare const symmKeys: {
@@ -878,8 +926,9 @@ declare const symmKeys: {
     unreadCount: (address?: Address, chainId?: number) => readonly ["symm", "unreadCount", `0x${string}` | undefined, number | undefined];
     availableMargin: (address?: Address, chainId?: number) => readonly ["symm", "availableMargin", `0x${string}` | undefined, number | undefined];
     delegation: (account?: Address, target?: Address, selectors?: readonly Hex[], chainId?: number) => readonly ["symm", "delegation", `0x${string}` | undefined, `0x${string}` | undefined, readonly `0x${string}`[] | undefined, number | undefined];
+    chartMetadata: (symbolsKey: string, positionKey: string) => readonly ["symm", "chartMetadata", string, string];
 };
 
 declare function getSymmErrorMessage(error: unknown): string;
 
-export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmDelegationState, type SymmInstantTradeActionArgs, type SymmInstantTradeRequest, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmDelegationParams, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmAvailableMargin, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDelegation, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmInstantTrade, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };
+export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmDelegationState, type SymmInstantTradeActionArgs, type SymmInstantTradeRequest, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmQueryConfig, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmDelegationParams, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmAvailableMargin, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDelegation, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmInstantTrade, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };

package/dist/react/index.d.ts

@@ -445,11 +445,39 @@ declare function useSymmAuth(): {
     refresh: (accountAddress?: viem.Address) => Promise<string | null>;
 };
 
+/**
+ * Consumer-facing query configuration.
+ * Allows overriding common TanStack Query options without
+ * affecting the hook's internal queryKey/queryFn/select.
+ */
+type SymmQueryConfig = {
+    /** Whether the query should execute. ANDed with the hook's internal conditions. */
+    enabled?: boolean;
+    /** Time in ms that data is considered fresh. Overrides the hook's default. */
+    staleTime?: number;
+    /** Time in ms that unused/inactive cache data remains in memory. */
+    gcTime?: number;
+    /** Polling interval in ms, or false to disable. */
+    refetchInterval?: number | false;
+    /** Refetch when the window regains focus. */
+    refetchOnWindowFocus?: boolean | 'always';
+    /** Refetch when the component mounts. */
+    refetchOnMount?: boolean | 'always';
+    /** Refetch when the network reconnects. */
+    refetchOnReconnect?: boolean | 'always';
+    /** Number of retry attempts on failure, or false to disable. */
+    retry?: boolean | number;
+    /** Delay between retries in ms, or a function of attempt index. */
+    retryDelay?: number | ((attemptIndex: number) => number);
+};
+
 type UseSymmDelegationParams = {
     accountAddress?: Address;
     target?: Address;
     selectors?: readonly Hex[];
+    /** @deprecated Use `query.enabled` instead. */
     enabled?: boolean;
+    query?: SymmQueryConfig;
 };
 type SymmDelegationState = {
     hasAccess: boolean;
@@ -494,7 +522,9 @@ declare function useSymmInstantTrade(params?: {
     execute: _tanstack_react_query.UseMutationResult<unknown, Error, SymmInstantTradeRequest, unknown>;
 };
 
-declare function useSymmAccounts(userAddress?: Address): {
+declare function useSymmAccounts(userAddress?: Address, options?: {
+    query?: SymmQueryConfig;
+}): {
     accounts: Account[];
     count: number;
     isLoading: boolean;
@@ -514,6 +544,7 @@ declare function useSymmApproval(params: {
     amount: bigint;
     spender?: Address;
     collateralToken?: Address;
+    query?: SymmQueryConfig;
 }): {
     approvalState: ApprovalState | null;
     allowance: bigint;
@@ -555,7 +586,9 @@ declare function useSymmCollateral(): {
     }, unknown>;
 };
 
-declare function useSymmSignature(userAddress?: Address): {
+declare function useSymmSignature(userAddress?: Address, options?: {
+    query?: SymmQueryConfig;
+}): {
     hasSigned: boolean;
     isLoading: boolean;
     signTerms: _tanstack_react_query.UseMutationResult<void, Error, void, unknown>;
@@ -564,6 +597,7 @@ declare function useSymmSignature(userAddress?: Address): {
 declare function useSymmAvailableMargin(params: {
     accountAddress?: Address;
     upnl?: bigint;
+    query?: SymmQueryConfig;
 }): {
     availableForOrder: bigint | null;
     stats: {
@@ -609,6 +643,7 @@ declare function useSymmBalances(params: {
     userAddress?: Address;
     chainId?: number;
     multiAccountAddress?: Address;
+    query?: SymmQueryConfig;
 }): {
     balanceInfo: node_modules__pear_protocol_symm_core_dist_types.BalanceInfoResponse | null;
     isLoading: boolean;
@@ -632,6 +667,7 @@ declare function useSymmPositions(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     positions: _pear_protocol_symm_core.OpenPositionDto[];
     isLoading: boolean;
@@ -642,6 +678,7 @@ declare function useSymmOpenOrders(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     orders: _pear_protocol_symm_core.UnifiedOrderItem[];
     isLoading: boolean;
@@ -652,6 +689,7 @@ declare function useSymmTradeHistory(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     trades: _pear_protocol_symm_shared.ApiResponse<unknown> | null;
     isLoading: boolean;
@@ -667,6 +705,7 @@ declare function useSymmTwap(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     twapOrders: node_modules__pear_protocol_symm_core_dist_types.TwapOrder[];
     isLoading: boolean;
@@ -676,6 +715,7 @@ declare function useSymmTwap(params: {
 declare function useSymmMarkets(params?: {
     chainId?: number;
     searchText?: string;
+    query?: SymmQueryConfig;
 }): {
     markets: _pear_protocol_symm_core.MarketGroupItem[];
     isLoading: boolean;
@@ -683,7 +723,9 @@ declare function useSymmMarkets(params?: {
 };
 
 type UseSymmHedgerMarketsParams = GetSymmHedgerMarketsRequest & {
+    /** @deprecated Use `query.enabled` instead. */
     enabled?: boolean;
+    query?: SymmQueryConfig;
 };
 declare function useSymmHedgerMarkets(params?: UseSymmHedgerMarketsParams): {
     data: _pear_protocol_symm_core.SymmHedgerMarketsResult | null;
@@ -703,6 +745,7 @@ declare function useSymmHedgerMarkets(params?: UseSymmHedgerMarketsParams): {
 
 declare function useSymmFunding(params?: {
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     rates: node_modules__pear_protocol_symm_core_dist_types.FundingRate[];
     isLoading: boolean;
@@ -712,6 +755,7 @@ declare function useSymmPortfolio(params: {
     accountAddress?: Address;
     mainAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     metrics: _pear_protocol_symm_core.PortfolioResponse | null;
     isLoading: boolean;
@@ -721,6 +765,7 @@ declare function useSymmPortfolio(params: {
 declare function useSymmNotifications(params: {
     userAddress?: Address;
     chainId?: number;
+    query?: SymmQueryConfig;
 }): {
     notifications: _pear_protocol_symm_core.Notification[];
     unreadCount: number;
@@ -792,7 +837,10 @@ interface UseSymmTokenSelectionMetadataReturn {
  * Fetches Binance market data for selected SYMM chart tokens and derives
  * chart header metrics (price ratio, weighted ratio, etc.).
  */
-declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection): UseSymmTokenSelectionMetadataReturn;
+declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection, options?: {
+    enabled?: boolean;
+    query?: SymmQueryConfig;
+}): UseSymmTokenSelectionMetadataReturn;
 
 /**
  * Candle interval type matching the chart system.
@@ -855,7 +903,7 @@ interface SymmPerformanceOverlay {
  */
 declare function useSymmPerformanceOverlays(selection: SymmChartSelection): {
     overlays: SymmPerformanceOverlay[];
-    generateOverlaySymbols: () => string[];
+    overlaySymbols: string[];
 };
 
 declare const symmKeys: {
@@ -878,8 +926,9 @@ declare const symmKeys: {
     unreadCount: (address?: Address, chainId?: number) => readonly ["symm", "unreadCount", `0x${string}` | undefined, number | undefined];
     availableMargin: (address?: Address, chainId?: number) => readonly ["symm", "availableMargin", `0x${string}` | undefined, number | undefined];
     delegation: (account?: Address, target?: Address, selectors?: readonly Hex[], chainId?: number) => readonly ["symm", "delegation", `0x${string}` | undefined, `0x${string}` | undefined, readonly `0x${string}`[] | undefined, number | undefined];
+    chartMetadata: (symbolsKey: string, positionKey: string) => readonly ["symm", "chartMetadata", string, string];
 };
 
 declare function getSymmErrorMessage(error: unknown): string;
 
-export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmDelegationState, type SymmInstantTradeActionArgs, type SymmInstantTradeRequest, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmDelegationParams, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmAvailableMargin, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDelegation, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmInstantTrade, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };
+export { type SymmChartSelection, type SymmChartSelectionInput, type SymmChartTokenSelection, type SymmContextValue, type SymmDelegationState, type SymmInstantTradeActionArgs, type SymmInstantTradeRequest, type SymmPerformanceOverlay, SymmProvider, type SymmProviderProps, type SymmQueryConfig, type SymmTokenMetadata, type UseSymmChartCandlesReturn, type UseSymmDelegationParams, type UseSymmHedgerMarketsParams, type UseSymmTokenSelectionMetadataReturn, getSymmErrorMessage, symmKeys, useSymmAccounts, useSymmApproval, useSymmAuth, useSymmAvailableMargin, useSymmBalances, useSymmChartCandles, useSymmChartSelection, useSymmCollateral, useSymmContext, useSymmCoreClient, useSymmDelegation, useSymmDeposit, useSymmFunding, useSymmHedgerMarkets, useSymmInstantTrade, useSymmMarkets, useSymmNotifications, useSymmOpenOrders, useSymmPerformanceOverlays, useSymmPortfolio, useSymmPositions, useSymmSignature, useSymmTokenSelectionMetadata, useSymmTpsl, useSymmTrade, useSymmTradeHistory, useSymmTwap, useSymmWithdraw, useSymmWs, useSymmioClient };