@orderly.network/hooks 2.10.1-alpha.0 → 2.10.2-alpha.0

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { SWRMutationConfiguration, SWRMutationResponse } from 'swr/mutation';
 import * as swr_infinite from 'swr/infinite';
 import { SWRInfiniteKeyLoader, SWRInfiniteConfiguration } from 'swr/infinite';
 import * as react from 'react';
-import react__default, { PropsWithChildren, FC, ReactNode } from 'react';
+import { PropsWithChildren, FC, ReactNode } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
 import { NetworkId, TrackerEventName, API, OrderlyOrder, ChainNamespace, WSMessage, OrderType, OrderStatus, OrderSide, AlgoOrderRootType, OrderEntity, PositionType, AlgoOrderEntity, AssetHistoryStatusEnum, AlgoOrderType, RequireKeys } from '@orderly.network/types';
 import * as _orderly_network_core from '@orderly.network/core';
@@ -37,7 +37,7 @@ declare global {
         };
     }
 }
-declare const _default: "2.10.1-alpha.0";
+declare const _default: "2.10.2-alpha.0";
 
 declare const fetcher: (url: string, init: RequestInit | undefined, queryOptions: useQueryOptions<any>) => Promise<any>;
 type useQueryOptions<T> = SWRConfiguration & {
@@ -132,23 +132,17 @@ declare const useMemoizedFn: <T extends noop>(fn?: T) => PickFunction<T>;
 
 interface AudioPlayerOptions {
     volume?: number;
-    loop?: boolean;
-    autoPlay?: boolean;
+    /** When true, play() will run; when false, play() no-ops. Used for on/off toggle. */
+    enabled?: boolean;
 }
-declare const useAudioPlayer: (src: string, options?: AudioPlayerOptions) => readonly [react__default.DetailedReactHTMLElement<{
-    controls: boolean;
-    ref: react__default.MutableRefObject<HTMLAudioElement | null>;
-    autoPlay: boolean | undefined;
-    src: string;
-    style: {
-        display: "none";
-    };
-    onPlay: () => void;
-    onPlaying: () => void;
-    onPause: () => void;
-    onEnded: () => void;
-    onError: () => void;
-}, HTMLAudioElement>, react__default.MutableRefObject<HTMLAudioElement | null>, "error" | "paused" | "idle" | "play" | "playing" | "ended"];
+/**
+ * Single shared Audio instance. Play is explicit: pause() then set src then play().
+ * Use for order-filled notification sound (and any other one-shot global sound).
+ * Compatible with legacy single-sound + on/off: pass enabled = user's on/off and src = media or "".
+ */
+declare const useAudioPlayer: (src: string, options?: AudioPlayerOptions) => {
+    play: () => void;
+};
 
 declare const useCommission: (options?: {
     size?: number;
@@ -477,6 +471,102 @@ declare function useChains<T extends NetworkId | undefined, K extends UseChainsO
     UseChainsReturnObject
 ];
 
+/**
+ * Check if currently trading based on next_open/next_close timestamps
+ * @param nextOpen - Next open time timestamp
+ * @param nextClose - Next close time timestamp
+ * @param currentTime - Current time timestamp
+ * @returns boolean - true if currently trading
+ */
+declare const isCurrentlyTrading: (nextClose: number, status: "open" | "close", currentTime?: number) => boolean;
+declare const isCurrentlyClosed: (nextOpen: number, status: "open" | "close", currentTime?: number) => boolean;
+/**
+ * Type alias for the return type of useSymbolsInfo hook
+ */
+type RwaSymbolsInfo = ReturnType<typeof useRwaSymbolsInfo>;
+/**
+ * A hook that provides access to symbol information.
+ *
+ * @returns A getter object that provides access to symbol information.
+ * The getter allows accessing symbol data either by symbol name directly,
+ * or through a two-level access pattern (symbol and property).
+ *
+ * @example
+ * ```typescript
+ * const rwaSymbolsInfo = useRwaSymbolsInfo();
+ *
+ * // Get all info for a symbol
+ * const ethInfo = rwaSymbolsInfo["PERP_ETH_USDC"]();
+ * ```
+ */
+declare const useRwaSymbolsInfo: () => Record<string, <Key extends keyof API.RwaSymbol>(key: Key, defaultValue?: API.RwaSymbol[Key] | undefined) => API.RwaSymbol[Key]> & Record<string, () => API.RwaSymbol> & {
+    isNil: boolean;
+};
+declare const useRwaSymbolsInfoStore: () => Record<string, API.RwaSymbol> | undefined;
+/**
+ * Return type definition for the hook
+ *
+ * - isRwa: true if the symbol is an RWA symbol
+ * - open: true if the symbol is open for trading
+ * - nextOpen: the next open time in milliseconds
+ * - nextClose: the next close time in milliseconds
+ * - closeTimeInterval: the time interval in seconds until the symbol closes (countdown format)
+ * - openTimeInterval: the time interval in seconds until the symbol opens (countdown format)
+ */
+interface RwaSymbolResult {
+    isRwa: boolean;
+    open?: boolean;
+    nextOpen?: number;
+    nextClose?: number;
+    closeTimeInterval?: number;
+    openTimeInterval?: number;
+}
+/**
+ * Hook to initialize and manage the global timer
+ * This hook should be called once at the top level of the application to start and manage the global timer
+ */
+declare const useInitRwaSymbolsRuntime: () => void;
+/**
+ * Hook to get current RWA symbol information with real-time updates
+ * Retrieves the state of a specific symbol from the centralized store
+ * @param symbol - The symbol to query
+ * @returns RwaSymbolResult containing RWA status and countdown information
+ */
+declare const useGetRwaSymbolInfo: (symbol: string) => RwaSymbolResult;
+/**
+ * Simplified hook to get RWA symbol open status with real-time updates
+ * @param symbol - The symbol to query
+ * @returns Object containing isRwa and open status
+ */
+declare const useGetRwaSymbolOpenStatus: (symbol: string) => {
+    isRwa: boolean;
+    open?: boolean;
+};
+/**
+ * Hook to get RWA symbol close time interval with filtering
+ * @param symbol - The symbol to query
+ * @param thresholdMinutes - Time threshold in minutes, defaults to 30
+ * @returns Close time interval in seconds, or undefined if not within threshold
+ */
+declare const useGetRwaSymbolCloseTimeInterval: (symbol: string, thresholdMinutes?: number) => {
+    isRwa: boolean;
+    open?: boolean;
+    closeTimeInterval?: number;
+    nextClose?: number;
+};
+/**
+ * Hook to get RWA symbol open time interval with filtering
+ * @param symbol - The symbol to query
+ * @param thresholdMinutes - Time threshold in minutes, defaults to 30
+ * @returns Open time interval in seconds, or undefined if not within threshold
+ */
+declare const useGetRwaSymbolOpenTimeInterval: (symbol: string, thresholdMinutes?: number) => {
+    isRwa: boolean;
+    open?: boolean;
+    openTimeInterval?: number;
+    nextOpen?: number;
+};
+
 type FilteredChains = {
     mainnet?: {
         id: number;
@@ -514,7 +604,9 @@ interface OrderlyConfigContextState {
         /**
          * Custom `/v1/public/futures` response data.
          */
-        symbolList?: (data: API.MarketInfoExt[]) => any[];
+        symbolList?: (data: API.MarketInfoExt[], context: {
+            rwaSymbolsInfo: RwaSymbolsInfo;
+        }) => any[];
         /**
          * custom `/v2/public/announcement` response data
          */
@@ -524,11 +616,16 @@ interface OrderlyConfigContextState {
         orderFilled?: {
             /**
              * Sound to play when an order is successful.
+             * If `soundOptions` is provided, this field is treated as the legacy
+             * single-sound configuration and only used when `soundOptions` is
+             * absent.
              * @default undefined
              */
             media?: string;
             /**
              * Whether to open the notification by default.
+             * For multi-sound mode this controls whether the initial selection
+             * should be sound-on or muted when there is no stored preference.
              * @default false
              */
             defaultOpen?: boolean;
@@ -537,6 +634,22 @@ interface OrderlyConfigContextState {
              * @default true
              */
             displayInOrderEntry?: boolean;
+            /**
+             * Multiple sound options for order filled notification.
+             * When provided, the UI should render a single-choice selector
+             * (e.g. radio group) instead of a simple on/off toggle. One of the
+             * options should represent the muted/off state.
+             */
+            soundOptions?: Array<{
+                label: string;
+                value: string;
+                media: string;
+            }>;
+            /**
+             * Default selected sound option value when there is no stored
+             * preference. If omitted, the first item in `soundOptions` is used.
+             */
+            defaultSoundValue?: string;
         };
     };
     amplitudeConfig?: {
@@ -1707,6 +1820,13 @@ declare const useStatisticsDaily: (params: QueryParams, options?: {
     };
 }];
 
+type UserStatistics = {
+    perp_trading_volume_last_24_hours?: number;
+};
+declare const useUserStatistics: () => readonly [UserStatistics | null, {
+    readonly isValidating: boolean;
+}];
+
 type FundingSearchParams = {
     /**
      * Data range for the funding fee history
@@ -1814,102 +1934,6 @@ declare const useTokensInfo: () => _orderly_network_types.API.Token[] | undefine
  */
 declare const useTokenInfo: (token: string) => _orderly_network_types.API.Token | undefined;
 
-/**
- * Check if currently trading based on next_open/next_close timestamps
- * @param nextOpen - Next open time timestamp
- * @param nextClose - Next close time timestamp
- * @param currentTime - Current time timestamp
- * @returns boolean - true if currently trading
- */
-declare const isCurrentlyTrading: (nextClose: number, status: "open" | "close", currentTime?: number) => boolean;
-declare const isCurrentlyClosed: (nextOpen: number, status: "open" | "close", currentTime?: number) => boolean;
-/**
- * Type alias for the return type of useSymbolsInfo hook
- */
-type RwaSymbolsInfo = ReturnType<typeof useRwaSymbolsInfo>;
-/**
- * A hook that provides access to symbol information.
- *
- * @returns A getter object that provides access to symbol information.
- * The getter allows accessing symbol data either by symbol name directly,
- * or through a two-level access pattern (symbol and property).
- *
- * @example
- * ```typescript
- * const rwaSymbolsInfo = useRwaSymbolsInfo();
- *
- * // Get all info for a symbol
- * const ethInfo = rwaSymbolsInfo["PERP_ETH_USDC"]();
- * ```
- */
-declare const useRwaSymbolsInfo: () => Record<string, <Key extends keyof API.RwaSymbol>(key: Key, defaultValue?: API.RwaSymbol[Key] | undefined) => API.RwaSymbol[Key]> & Record<string, () => API.RwaSymbol> & {
-    isNil: boolean;
-};
-declare const useRwaSymbolsInfoStore: () => Record<string, API.RwaSymbol> | undefined;
-/**
- * Return type definition for the hook
- *
- * - isRwa: true if the symbol is an RWA symbol
- * - open: true if the symbol is open for trading
- * - nextOpen: the next open time in milliseconds
- * - nextClose: the next close time in milliseconds
- * - closeTimeInterval: the time interval in seconds until the symbol closes (countdown format)
- * - openTimeInterval: the time interval in seconds until the symbol opens (countdown format)
- */
-interface RwaSymbolResult {
-    isRwa: boolean;
-    open?: boolean;
-    nextOpen?: number;
-    nextClose?: number;
-    closeTimeInterval?: number;
-    openTimeInterval?: number;
-}
-/**
- * Hook to initialize and manage the global timer
- * This hook should be called once at the top level of the application to start and manage the global timer
- */
-declare const useInitRwaSymbolsRuntime: () => void;
-/**
- * Hook to get current RWA symbol information with real-time updates
- * Retrieves the state of a specific symbol from the centralized store
- * @param symbol - The symbol to query
- * @returns RwaSymbolResult containing RWA status and countdown information
- */
-declare const useGetRwaSymbolInfo: (symbol: string) => RwaSymbolResult;
-/**
- * Simplified hook to get RWA symbol open status with real-time updates
- * @param symbol - The symbol to query
- * @returns Object containing isRwa and open status
- */
-declare const useGetRwaSymbolOpenStatus: (symbol: string) => {
-    isRwa: boolean;
-    open?: boolean;
-};
-/**
- * Hook to get RWA symbol close time interval with filtering
- * @param symbol - The symbol to query
- * @param thresholdMinutes - Time threshold in minutes, defaults to 30
- * @returns Close time interval in seconds, or undefined if not within threshold
- */
-declare const useGetRwaSymbolCloseTimeInterval: (symbol: string, thresholdMinutes?: number) => {
-    isRwa: boolean;
-    open?: boolean;
-    closeTimeInterval?: number;
-    nextClose?: number;
-};
-/**
- * Hook to get RWA symbol open time interval with filtering
- * @param symbol - The symbol to query
- * @param thresholdMinutes - Time threshold in minutes, defaults to 30
- * @returns Open time interval in seconds, or undefined if not within threshold
- */
-declare const useGetRwaSymbolOpenTimeInterval: (symbol: string, thresholdMinutes?: number) => {
-    isRwa: boolean;
-    open?: boolean;
-    openTimeInterval?: number;
-    nextOpen?: number;
-};
-
 type AppStatus = {
     positionsLoading: boolean;
     ordersLoading: boolean;
@@ -2948,4 +2972,4 @@ declare const useGetEstLiqPrice: (props: {
     side: OrderSide;
 }) => number | null;
 
-export { type APIKeyItem, type AccountRewardsHistory, type AccountRewardsHistoryRow, type Brokers, type Chain, type ChainFilter, type Chains, type CheckReferralCodeReturns, type CollateralOutputs, type ComputedAlgoOrder, type ConfigProviderProps, type ConnectedChain, type CurrentEpochEstimate, DefaultLayoutConfig, DistributionId, type DrawOptions, ENVType, ERROR_MSG_CODES, type EpochInfoItem, type EpochInfoType, EpochStatus, type ExclusiveConfigProviderProps, ExtendedConfigStore, type Favorite, type FavoriteTab, type FilteredChains, type FundingRates, MaintenanceStatus, type MarginRatioReturn, type MarketsItem, MarketsStorageKey, type MarketsStore, MarketsType, type NewListing, ORDERLY_ORDERBOOK_DEPTH_KEY, type OrderBookItem, type OrderEntryReturn, type OrderMetadata, type OrderMetadataConfig, type OrderParams, type OrderValidationItem, type OrderValidationResult, type OrderbookData, type OrderbookOptions, type OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, type PosterLayoutConfig, type PriceMode, type Recent, RefferalAPI, type RestrictedInfoOptions, type RestrictedInfoReturns, type RwaSymbolResult, type RwaSymbolsInfo, ScopeType, type StatusInfo, StatusProvider, type SymbolsInfo, TWType, type UseChainsOptions, type UseChainsReturnObject, type UseDepositReturn, type UseOrderEntryMetaState, WalletConnectorContext, type WalletConnectorContextState, type WalletRewards, type WalletRewardsHistoryReturns, type WalletRewardsItem, type WalletState, WsNetworkStatus, checkNotional, cleanStringStyle, fetcher, findPositionTPSLFromOrders, findTPSLFromOrder, findTPSLOrderPriceFromOrder, getMinNotional, getPriceKey, indexedDBManager, initializeAppDatabase, isCurrentlyClosed, isCurrentlyTrading, noCacheConfig, parseJSON, persistIndexedDB, resetTimestampOffsetState, timestampWaitingMiddleware, useAccount, useAccountInfo, useAccountInstance, useAccountRewardsHistory, useAllBrokers, useApiKeyManager, useAppStore, useAssetsHistory, useAudioPlayer, useBalanceSubscription, useBalanceTopic, useBoolean, useChain, useChainInfo, useChains, useCheckReferralCode, useCollateral, useCommission, useComputedLTV, useConfig, useConvert, useCurEpochEstimate, useDaily, useDeposit, useDistribution, useDistributionHistory, useEpochInfo, useEstLiqPriceBySymbol, useEventEmitter, useFeeState, useFundingDetails, useFundingFeeHistory, useFundingRate, useFundingRateBySymbol, useFundingRateHistory, useFundingRates, useFundingRatesStore, useGetClaimed, useGetEnv, useGetEstLiqPrice, useGetReferralCode, useGetRwaSymbolCloseTimeInterval, useGetRwaSymbolInfo, useGetRwaSymbolOpenStatus, useGetRwaSymbolOpenTimeInterval, useHoldingStream, useIndexPrice, useIndexPricesStream, useInfiniteQuery, useInitRwaSymbolsRuntime, useInternalTransfer, useKeyStore, useLazyQuery, useLeverage, useLeverageBySymbol, useLocalStorage, useMainTokenStore, useMainnetChainsStore, useMaintenanceStatus, useMarginRatio, useMarkPrice, useMarkPriceBySymbol, useMarkPricesStream, useMarket, useMarketList, useMarketMap, useMarketTradeStream, useMarkets, useMarketsStore, useMarketsStream, useMaxLeverage, useMaxQty, useMaxWithdrawal, useMediaQuery, useMemoizedFn, useMutation, useNetworkInfo, useOdosQuote, useOrderEntity, useOrderEntry, useOrderEntry$1 as useOrderEntry_deprecated, useOrderStore, useOrderStream, useOrderbookStream, useOrderlyContext, usePortfolio, usePositionActions, usePositionClose, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, type useQueryOptions, useRefereeHistory, useRefereeInfo, useRefereeRebateSummary, useReferralInfo, useReferralRebateSummary, useRestrictedInfo, useRwaSymbolsInfo, useRwaSymbolsInfoStore, useSessionStorage, useSettleSubscription, useSimpleDI, useStatisticsDaily, useStorageChain, useStorageLedgerAddress, useSubAccountAlgoOrderStream, useSubAccountDataObserver, useSubAccountMaxWithdrawal, useSubAccountMutation, useSubAccountQuery, useSubAccountWS, useSwapSupportStore, useSymbolInfo, useSymbolLeverage, useSymbolPriceRange, useSymbolsInfo, useSymbolsInfoStore, useTPSLOrder, useTestTokenStore, useTestnetChainsStore, useTickerStream, useTokenInfo, useTokensInfo, useTpslPriceChecker, useTrack, useTrackingInstance, useTradingRewardsStatus, useTransfer, useTransferHistory, useUpdatedRef, useVaultsHistory, useWS, useWalletConnector, useWalletRewardsHistory, useWalletSubscription, useWalletTopic, useWithdraw, useWsStatus, index as utils, _default as version };
+export { type APIKeyItem, type AccountRewardsHistory, type AccountRewardsHistoryRow, type Brokers, type Chain, type ChainFilter, type Chains, type CheckReferralCodeReturns, type CollateralOutputs, type ComputedAlgoOrder, type ConfigProviderProps, type ConnectedChain, type CurrentEpochEstimate, DefaultLayoutConfig, DistributionId, type DrawOptions, ENVType, ERROR_MSG_CODES, type EpochInfoItem, type EpochInfoType, EpochStatus, type ExclusiveConfigProviderProps, ExtendedConfigStore, type Favorite, type FavoriteTab, type FilteredChains, type FundingRates, MaintenanceStatus, type MarginRatioReturn, type MarketsItem, MarketsStorageKey, type MarketsStore, MarketsType, type NewListing, ORDERLY_ORDERBOOK_DEPTH_KEY, type OrderBookItem, type OrderEntryReturn, type OrderMetadata, type OrderMetadataConfig, type OrderParams, type OrderValidationItem, type OrderValidationResult, type OrderbookData, type OrderbookOptions, type OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, type PosterLayoutConfig, type PriceMode, type Recent, RefferalAPI, type RestrictedInfoOptions, type RestrictedInfoReturns, type RwaSymbolResult, type RwaSymbolsInfo, ScopeType, type StatusInfo, StatusProvider, type SymbolsInfo, TWType, type UseChainsOptions, type UseChainsReturnObject, type UseDepositReturn, type UseOrderEntryMetaState, WalletConnectorContext, type WalletConnectorContextState, type WalletRewards, type WalletRewardsHistoryReturns, type WalletRewardsItem, type WalletState, WsNetworkStatus, checkNotional, cleanStringStyle, fetcher, findPositionTPSLFromOrders, findTPSLFromOrder, findTPSLOrderPriceFromOrder, getMinNotional, getPriceKey, indexedDBManager, initializeAppDatabase, isCurrentlyClosed, isCurrentlyTrading, noCacheConfig, parseJSON, persistIndexedDB, resetTimestampOffsetState, timestampWaitingMiddleware, useAccount, useAccountInfo, useAccountInstance, useAccountRewardsHistory, useAllBrokers, useApiKeyManager, useAppStore, useAssetsHistory, useAudioPlayer, useBalanceSubscription, useBalanceTopic, useBoolean, useChain, useChainInfo, useChains, useCheckReferralCode, useCollateral, useCommission, useComputedLTV, useConfig, useConvert, useCurEpochEstimate, useDaily, useDeposit, useDistribution, useDistributionHistory, useEpochInfo, useEstLiqPriceBySymbol, useEventEmitter, useFeeState, useFundingDetails, useFundingFeeHistory, useFundingRate, useFundingRateBySymbol, useFundingRateHistory, useFundingRates, useFundingRatesStore, useGetClaimed, useGetEnv, useGetEstLiqPrice, useGetReferralCode, useGetRwaSymbolCloseTimeInterval, useGetRwaSymbolInfo, useGetRwaSymbolOpenStatus, useGetRwaSymbolOpenTimeInterval, useHoldingStream, useIndexPrice, useIndexPricesStream, useInfiniteQuery, useInitRwaSymbolsRuntime, useInternalTransfer, useKeyStore, useLazyQuery, useLeverage, useLeverageBySymbol, useLocalStorage, useMainTokenStore, useMainnetChainsStore, useMaintenanceStatus, useMarginRatio, useMarkPrice, useMarkPriceBySymbol, useMarkPricesStream, useMarket, useMarketList, useMarketMap, useMarketTradeStream, useMarkets, useMarketsStore, useMarketsStream, useMaxLeverage, useMaxQty, useMaxWithdrawal, useMediaQuery, useMemoizedFn, useMutation, useNetworkInfo, useOdosQuote, useOrderEntity, useOrderEntry, useOrderEntry$1 as useOrderEntry_deprecated, useOrderStore, useOrderStream, useOrderbookStream, useOrderlyContext, usePortfolio, usePositionActions, usePositionClose, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, type useQueryOptions, useRefereeHistory, useRefereeInfo, useRefereeRebateSummary, useReferralInfo, useReferralRebateSummary, useRestrictedInfo, useRwaSymbolsInfo, useRwaSymbolsInfoStore, useSessionStorage, useSettleSubscription, useSimpleDI, useStatisticsDaily, useStorageChain, useStorageLedgerAddress, useSubAccountAlgoOrderStream, useSubAccountDataObserver, useSubAccountMaxWithdrawal, useSubAccountMutation, useSubAccountQuery, useSubAccountWS, useSwapSupportStore, useSymbolInfo, useSymbolLeverage, useSymbolPriceRange, useSymbolsInfo, useSymbolsInfoStore, useTPSLOrder, useTestTokenStore, useTestnetChainsStore, useTickerStream, useTokenInfo, useTokensInfo, useTpslPriceChecker, useTrack, useTrackingInstance, useTradingRewardsStatus, useTransfer, useTransferHistory, useUpdatedRef, useUserStatistics, useVaultsHistory, useWS, useWalletConnector, useWalletRewardsHistory, useWalletSubscription, useWalletTopic, useWithdraw, useWsStatus, index as utils, _default as version };