@orderly.network/hooks 1.0.13 → 1.0.15

package/dist/index.d.mts

@@ -1,21 +1,22 @@
 import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfig, SWRConfiguration, default as useSWR } from 'swr';
-import * as swr__internal from 'swr/_internal';
 import { SWRMutationConfiguration, SWRMutationResponse } from 'swr/mutation';
 import * as swr_infinite from 'swr/infinite';
 import { SWRInfiniteKeyLoader, SWRInfiniteConfiguration } from 'swr/infinite';
+import * as swr__internal from 'swr/_internal';
 import * as _orderly_network_core from '@orderly.network/core';
 import { AccountState, Account, EventEmitter, ConfigKey, ConfigStore, OrderlyKeyStore, getWalletAdapterFunc } from '@orderly.network/core';
 export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
 import * as react from 'react';
-import react__default, { PropsWithChildren } from 'react';
+import { PropsWithChildren } from 'react';
 import { NetworkId, OrderSide, OrderEntity, API, WSMessage, OrderStatus, WS_WalletStatusEnum } from '@orderly.network/types';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as swr_subscription from 'swr/subscription';
 import { Decimal } from '@orderly.network/utils';
 export * from 'use-debounce';
 
-declare type useQueryOptions<T> = SWRConfiguration & {
+type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
 };
 
@@ -33,13 +34,13 @@ declare const useQuery: <T>(query: Parameters<typeof useSWR>["0"], options?: use
  * @param query
  * @param options
  */
-declare const useLazyQuery: <T, R = any>(query: Parameters<typeof useSWR>["0"], options?: (SWRMutationConfiguration<any, any, swr__internal.Key, any, any> & {
+declare const useLazyQuery: <T, R = any>(query: Parameters<typeof useSWR>["0"], options?: (SWRMutationConfiguration<any, any> & {
     formatter?: ((data: any) => R) | undefined;
     init?: RequestInit | undefined;
 }) | undefined) => SWRMutationResponse;
 
-declare type HTTP_METHOD = "POST" | "PUT" | "DELETE";
-declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E, swr__internal.Key, any, any> | undefined) => readonly [(data: any, params?: any) => Promise<any>, {
+type HTTP_METHOD = "POST" | "PUT" | "DELETE";
+declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E> | undefined) => readonly [(data: any, params?: any) => Promise<any>, {
     readonly data: any;
     readonly error: E | undefined;
     readonly reset: () => void;
@@ -86,7 +87,7 @@ declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value:
 
 declare const useWS: () => WS;
 
-declare const useConfig: <T>(key?: ConfigKey | undefined, defaultValue?: T | undefined) => ConfigStore | T;
+declare const useConfig: <T>(key?: ConfigKey, defaultValue?: T | undefined) => ConfigStore | T;
 
 interface OrderlyConfigContextState {
     fetcher?: (url: string, init: RequestInit) => Promise<any>;
@@ -94,13 +95,19 @@ interface OrderlyConfigContextState {
     keyStore: OrderlyKeyStore;
     getWalletAdapter: getWalletAdapterFunc;
     networkId: NetworkId;
+    /**
+     * @hidden
+     */
     onlyTestnet?: boolean;
+    /**
+     * @hidden
+     */
     enableSwapDeposit?: boolean;
 }
 declare const OrderlyContext: react.Context<OrderlyConfigContextState>;
 declare const OrderlyProvider: react.Provider<OrderlyConfigContextState>;
 
-declare type RequireAtLeastOne<T, R extends keyof T = keyof T> = Omit<T, R> & {
+type RequireAtLeastOne<T, R extends keyof T = keyof T> = Omit<T, R> & {
     [K in R]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<R, K>>>;
 }[R];
 interface ConfigProviderProps {
@@ -111,9 +118,9 @@ interface ConfigProviderProps {
     networkId: NetworkId;
     enableSwapDeposit?: boolean;
 }
-declare const OrderlyConfigProvider: (props: PropsWithChildren<RequireAtLeastOne<ConfigProviderProps, "brokerId" | "configStore">>) => react__default.JSX.Element | null;
+declare const OrderlyConfigProvider: (props: PropsWithChildren<RequireAtLeastOne<ConfigProviderProps, "brokerId" | "configStore">>) => react_jsx_runtime.JSX.Element | null;
 
-declare type ConnectedChain = {
+type ConnectedChain = {
     id: string;
 };
 interface WalletConnectorContextState {
@@ -132,19 +139,19 @@ interface WalletConnectorContextState {
 declare const WalletConnectorContext: react.Context<WalletConnectorContextState>;
 declare const useWalletConnector: () => WalletConnectorContextState;
 
-declare type OrderBookItem = number[];
-declare type OrderbookData = {
+type OrderBookItem = number[];
+type OrderbookData = {
     asks: OrderBookItem[];
     bids: OrderBookItem[];
 };
-declare type OrderbookOptions = {
+type OrderbookOptions = {
     level?: number;
 };
 /**
  * @name useOrderbookStream
  * @description React hook that returns the current orderbook for a given market
  */
-declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions | undefined) => ({
+declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
     asks: OrderBookItem[];
     bids: OrderBookItem[];
     markPrice: any;
@@ -166,7 +173,7 @@ declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, opti
     middlePrice?: undefined;
 })[];
 
-declare type UseOrderEntryOptions = {
+type UseOrderEntryOptions = {
     commify?: boolean;
     validate?: (data: OrderEntity) => {
         [P in keyof OrderEntity]?: string;
@@ -177,7 +184,7 @@ declare type UseOrderEntryOptions = {
  * @param symbol
  * @returns
  */
-declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions | undefined) => {
+declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions) => {
     maxQty: number;
     freeCollateral: number;
     markPrice: any;
@@ -221,7 +228,7 @@ declare const useFundingRate: (symbol: string) => {
     sum_unitary_funding?: number | undefined;
 };
 
-declare const usePositionStream: (symbol?: string | undefined, options?: Partial<swr__internal.PublicConfiguration<any, any, swr__internal.BareFetcher<any>>> | undefined) => readonly [{
+declare const usePositionStream: (symbol?: string, options?: SWRConfiguration) => readonly [{
     readonly rows: API.PositionExt[] | null;
     readonly aggregated: any;
     readonly totalCollateral: Decimal;
@@ -234,7 +241,7 @@ declare const usePositionStream: (symbol?: string | undefined, options?: Partial
     readonly refresh: () => void;
 }];
 
-declare type Params = {
+type Params = {
     symbol?: string;
     status?: OrderStatus;
     size?: number;
@@ -246,7 +253,11 @@ declare const useOrderStream: (params: Params) => readonly [any[] | null, {
     readonly loadMore: () => void;
     readonly cancelAllOrders: () => void;
     readonly updateOrder: (orderId: string, order: OrderEntity) => Promise<any>;
-    readonly cancelOrder: (orderId: string, symbol?: string | undefined) => Promise<void>;
+    readonly cancelOrder: (orderId: string, symbol?: string) => Promise<void>;
+    readonly errors: {
+        readonly cancelOrder: unknown;
+        readonly updateOrder: unknown;
+    };
 }];
 
 interface MarketTradeStreamOptions {
@@ -257,14 +268,14 @@ declare const useMarketTradeStream: (symbol: string, options?: MarketTradeStream
     isLoading: boolean;
 };
 
-declare type CollateralOutputs = {
+type CollateralOutputs = {
     totalCollateral: number;
     freeCollateral: number;
     totalValue: number;
     availableBalance: number;
     unsettledPnL: number;
 };
-declare type Options = {
+type Options = {
     dp: number;
 };
 declare const useCollateral: (options?: Options) => CollateralOutputs;
@@ -276,18 +287,18 @@ declare const useMarginRatio: () => {
     currentLeverage: number;
 };
 
-declare type inputOptions = {
+type inputOptions = {
     filter?: (item: API.Chain) => boolean;
     pick?: "dexs" | "network_infos" | "token_infos";
     crossEnabled?: boolean;
     /** if true, use wooSwap api, else use orderly api only  */
     wooSwapEnabled?: boolean;
 };
-declare const useChains: (networkId?: NetworkId | undefined, options?: inputOptions & SWRConfiguration) => readonly [API.Chain[] | {
+declare const useChains: (networkId?: NetworkId, options?: inputOptions & SWRConfiguration) => readonly [API.Chain[] | {
     testnet: API.Chain[];
     mainnet: API.Chain[];
 }, {
-    readonly findByChainId: (chainId: number, field?: string | undefined) => (API.Chain & {
+    readonly findByChainId: (chainId: number, field?: string) => (API.Chain & {
         nativeToken?: API.TokenInfo | undefined;
     }) | undefined;
     readonly error: any;
@@ -310,7 +321,7 @@ declare const useWithdraw: () => {
     unsettledPnL: number;
 };
 
-declare type useDepositOptions = {
+type useDepositOptions = {
     address?: string;
     decimals?: number;
     crossChainRouteAddress?: string;
@@ -323,7 +334,7 @@ declare type useDepositOptions = {
      */
     wooSwapEnabled?: boolean;
 };
-declare const useDeposit: (options?: useDepositOptions | undefined) => {
+declare const useDeposit: (options?: useDepositOptions) => {
     dst: {
         symbol: string;
         address: string | undefined;
@@ -339,7 +350,7 @@ declare const useDeposit: (options?: useDepositOptions | undefined) => {
     approve: (amount: string | undefined) => Promise<any>;
     deposit: (amount: string) => Promise<any>;
     fetchBalances: (tokens: API.TokenInfo[]) => Promise<void>;
-    fetchBalance: (address: string, decimals?: number | undefined) => Promise<string>;
+    fetchBalance: (address: string, decimals?: number) => Promise<string>;
 };
 
 declare const useHoldingStream: () => {

package/dist/index.d.ts

@@ -1,21 +1,22 @@
 import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfig, SWRConfiguration, default as useSWR } from 'swr';
-import * as swr__internal from 'swr/_internal';
 import { SWRMutationConfiguration, SWRMutationResponse } from 'swr/mutation';
 import * as swr_infinite from 'swr/infinite';
 import { SWRInfiniteKeyLoader, SWRInfiniteConfiguration } from 'swr/infinite';
+import * as swr__internal from 'swr/_internal';
 import * as _orderly_network_core from '@orderly.network/core';
 import { AccountState, Account, EventEmitter, ConfigKey, ConfigStore, OrderlyKeyStore, getWalletAdapterFunc } from '@orderly.network/core';
 export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
 import * as react from 'react';
-import react__default, { PropsWithChildren } from 'react';
+import { PropsWithChildren } from 'react';
 import { NetworkId, OrderSide, OrderEntity, API, WSMessage, OrderStatus, WS_WalletStatusEnum } from '@orderly.network/types';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as swr_subscription from 'swr/subscription';
 import { Decimal } from '@orderly.network/utils';
 export * from 'use-debounce';
 
-declare type useQueryOptions<T> = SWRConfiguration & {
+type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
 };
 
@@ -33,13 +34,13 @@ declare const useQuery: <T>(query: Parameters<typeof useSWR>["0"], options?: use
  * @param query
  * @param options
  */
-declare const useLazyQuery: <T, R = any>(query: Parameters<typeof useSWR>["0"], options?: (SWRMutationConfiguration<any, any, swr__internal.Key, any, any> & {
+declare const useLazyQuery: <T, R = any>(query: Parameters<typeof useSWR>["0"], options?: (SWRMutationConfiguration<any, any> & {
     formatter?: ((data: any) => R) | undefined;
     init?: RequestInit | undefined;
 }) | undefined) => SWRMutationResponse;
 
-declare type HTTP_METHOD = "POST" | "PUT" | "DELETE";
-declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E, swr__internal.Key, any, any> | undefined) => readonly [(data: any, params?: any) => Promise<any>, {
+type HTTP_METHOD = "POST" | "PUT" | "DELETE";
+declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E> | undefined) => readonly [(data: any, params?: any) => Promise<any>, {
     readonly data: any;
     readonly error: E | undefined;
     readonly reset: () => void;
@@ -86,7 +87,7 @@ declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value:
 
 declare const useWS: () => WS;
 
-declare const useConfig: <T>(key?: ConfigKey | undefined, defaultValue?: T | undefined) => ConfigStore | T;
+declare const useConfig: <T>(key?: ConfigKey, defaultValue?: T | undefined) => ConfigStore | T;
 
 interface OrderlyConfigContextState {
     fetcher?: (url: string, init: RequestInit) => Promise<any>;
@@ -94,13 +95,19 @@ interface OrderlyConfigContextState {
     keyStore: OrderlyKeyStore;
     getWalletAdapter: getWalletAdapterFunc;
     networkId: NetworkId;
+    /**
+     * @hidden
+     */
     onlyTestnet?: boolean;
+    /**
+     * @hidden
+     */
     enableSwapDeposit?: boolean;
 }
 declare const OrderlyContext: react.Context<OrderlyConfigContextState>;
 declare const OrderlyProvider: react.Provider<OrderlyConfigContextState>;
 
-declare type RequireAtLeastOne<T, R extends keyof T = keyof T> = Omit<T, R> & {
+type RequireAtLeastOne<T, R extends keyof T = keyof T> = Omit<T, R> & {
     [K in R]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<R, K>>>;
 }[R];
 interface ConfigProviderProps {
@@ -111,9 +118,9 @@ interface ConfigProviderProps {
     networkId: NetworkId;
     enableSwapDeposit?: boolean;
 }
-declare const OrderlyConfigProvider: (props: PropsWithChildren<RequireAtLeastOne<ConfigProviderProps, "brokerId" | "configStore">>) => react__default.JSX.Element | null;
+declare const OrderlyConfigProvider: (props: PropsWithChildren<RequireAtLeastOne<ConfigProviderProps, "brokerId" | "configStore">>) => react_jsx_runtime.JSX.Element | null;
 
-declare type ConnectedChain = {
+type ConnectedChain = {
     id: string;
 };
 interface WalletConnectorContextState {
@@ -132,19 +139,19 @@ interface WalletConnectorContextState {
 declare const WalletConnectorContext: react.Context<WalletConnectorContextState>;
 declare const useWalletConnector: () => WalletConnectorContextState;
 
-declare type OrderBookItem = number[];
-declare type OrderbookData = {
+type OrderBookItem = number[];
+type OrderbookData = {
     asks: OrderBookItem[];
     bids: OrderBookItem[];
 };
-declare type OrderbookOptions = {
+type OrderbookOptions = {
     level?: number;
 };
 /**
  * @name useOrderbookStream
  * @description React hook that returns the current orderbook for a given market
  */
-declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions | undefined) => ({
+declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
     asks: OrderBookItem[];
     bids: OrderBookItem[];
     markPrice: any;
@@ -166,7 +173,7 @@ declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, opti
     middlePrice?: undefined;
 })[];
 
-declare type UseOrderEntryOptions = {
+type UseOrderEntryOptions = {
     commify?: boolean;
     validate?: (data: OrderEntity) => {
         [P in keyof OrderEntity]?: string;
@@ -177,7 +184,7 @@ declare type UseOrderEntryOptions = {
  * @param symbol
  * @returns
  */
-declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions | undefined) => {
+declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions) => {
     maxQty: number;
     freeCollateral: number;
     markPrice: any;
@@ -221,7 +228,7 @@ declare const useFundingRate: (symbol: string) => {
     sum_unitary_funding?: number | undefined;
 };
 
-declare const usePositionStream: (symbol?: string | undefined, options?: Partial<swr__internal.PublicConfiguration<any, any, swr__internal.BareFetcher<any>>> | undefined) => readonly [{
+declare const usePositionStream: (symbol?: string, options?: SWRConfiguration) => readonly [{
     readonly rows: API.PositionExt[] | null;
     readonly aggregated: any;
     readonly totalCollateral: Decimal;
@@ -234,7 +241,7 @@ declare const usePositionStream: (symbol?: string | undefined, options?: Partial
     readonly refresh: () => void;
 }];
 
-declare type Params = {
+type Params = {
     symbol?: string;
     status?: OrderStatus;
     size?: number;
@@ -246,7 +253,11 @@ declare const useOrderStream: (params: Params) => readonly [any[] | null, {
     readonly loadMore: () => void;
     readonly cancelAllOrders: () => void;
     readonly updateOrder: (orderId: string, order: OrderEntity) => Promise<any>;
-    readonly cancelOrder: (orderId: string, symbol?: string | undefined) => Promise<void>;
+    readonly cancelOrder: (orderId: string, symbol?: string) => Promise<void>;
+    readonly errors: {
+        readonly cancelOrder: unknown;
+        readonly updateOrder: unknown;
+    };
 }];
 
 interface MarketTradeStreamOptions {
@@ -257,14 +268,14 @@ declare const useMarketTradeStream: (symbol: string, options?: MarketTradeStream
     isLoading: boolean;
 };
 
-declare type CollateralOutputs = {
+type CollateralOutputs = {
     totalCollateral: number;
     freeCollateral: number;
     totalValue: number;
     availableBalance: number;
     unsettledPnL: number;
 };
-declare type Options = {
+type Options = {
     dp: number;
 };
 declare const useCollateral: (options?: Options) => CollateralOutputs;
@@ -276,18 +287,18 @@ declare const useMarginRatio: () => {
     currentLeverage: number;
 };
 
-declare type inputOptions = {
+type inputOptions = {
     filter?: (item: API.Chain) => boolean;
     pick?: "dexs" | "network_infos" | "token_infos";
     crossEnabled?: boolean;
     /** if true, use wooSwap api, else use orderly api only  */
     wooSwapEnabled?: boolean;
 };
-declare const useChains: (networkId?: NetworkId | undefined, options?: inputOptions & SWRConfiguration) => readonly [API.Chain[] | {
+declare const useChains: (networkId?: NetworkId, options?: inputOptions & SWRConfiguration) => readonly [API.Chain[] | {
     testnet: API.Chain[];
     mainnet: API.Chain[];
 }, {
-    readonly findByChainId: (chainId: number, field?: string | undefined) => (API.Chain & {
+    readonly findByChainId: (chainId: number, field?: string) => (API.Chain & {
         nativeToken?: API.TokenInfo | undefined;
     }) | undefined;
     readonly error: any;
@@ -310,7 +321,7 @@ declare const useWithdraw: () => {
     unsettledPnL: number;
 };
 
-declare type useDepositOptions = {
+type useDepositOptions = {
     address?: string;
     decimals?: number;
     crossChainRouteAddress?: string;
@@ -323,7 +334,7 @@ declare type useDepositOptions = {
      */
     wooSwapEnabled?: boolean;
 };
-declare const useDeposit: (options?: useDepositOptions | undefined) => {
+declare const useDeposit: (options?: useDepositOptions) => {
     dst: {
         symbol: string;
         address: string | undefined;
@@ -339,7 +350,7 @@ declare const useDeposit: (options?: useDepositOptions | undefined) => {
     approve: (amount: string | undefined) => Promise<any>;
     deposit: (amount: string) => Promise<any>;
     fetchBalances: (tokens: API.TokenInfo[]) => Promise<void>;
-    fetchBalance: (address: string, decimals?: number | undefined) => Promise<string>;
+    fetchBalance: (address: string, decimals?: number) => Promise<string>;
 };
 
 declare const useHoldingStream: () => {