@orderly.network/hooks 1.1.4-alpha.0 → 1.1.4-alpha.10

package/dist/index.d.mts

@@ -25,7 +25,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.1.4-alpha.0";
+declare const _default: "1.1.4-alpha.10";
 
 type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
@@ -96,6 +96,8 @@ declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data:
 
 declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value: T) => void];
 
+declare function parseJSON<T>(value: string | null): T | undefined;
+
 declare const useWS: () => WS;
 
 declare const useConfig: <T>(key?: ConfigKey, defaultValue?: T | undefined) => ConfigStore | T;
@@ -179,8 +181,15 @@ type OrderbookData = {
     asks: OrderBookItem[];
     bids: OrderBookItem[];
 };
+/**
+ * Configuration for the Order Book
+ * @level Indicates the number of data entries to return for ask/bid, default is 10
+ * @padding Whether to fill in when the actual data entries are less than the level. If filled, it will add [nan, nan, nan, nan]
+ *          default is true
+ */
 type OrderbookOptions = {
     level?: number;
+    padding?: boolean;
 };
 /**
  * @name useOrderbookStream
@@ -244,21 +253,30 @@ type UseOrderEntryReturn = {
     metaState: UseOrderEntryMetaState;
     symbolConfig: API.SymbolExt;
 };
-type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">> & {};
+type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">>;
 /**
  * Create Order
  * @example
  * ```tsx
+ * import { useOrderEntry } from "@orderly.network/hooks";
+ * import {OrderSide, OrderType} from '@orderly.network/types';
+ *
  * const { formattedOrder, onSubmit, helper } = useOrderEntry({
  *  symbol: "PERP_ETH_USDC",
  *  side: OrderSide.BUY,
  *  order_type: OrderType.LIMIT,
  *  order_price: 10000,
  *  order_quantity: 1,
+ * },{
+ *  // **Note:** it's required
+ *  watchOrderbook: true,
  * });
  * ```
  */
 declare function useOrderEntry(order: OrderParams, options?: UseOrderEntryOptions): UseOrderEntryReturn;
+/**
+ * @deprecated
+ */
 declare function useOrderEntry(symbol: string, side: OrderSide, reduceOnly: boolean): UseOrderEntryReturn;
 
 declare const useSymbolsInfo: () => Record<string, any>;
@@ -475,7 +493,7 @@ declare const useDeposit: (options?: useDepositOptions) => {
     depositFee: bigint;
     /** enquiring depositFee status on chain */
     depositFeeRevalidating: boolean;
-    approve: (amount?: string) => Promise<any>;
+    approve: (amount?: string) => Promise<void | undefined>;
     deposit: () => Promise<any>;
     fetchBalances: (tokens: API.TokenInfo[]) => Promise<void>;
     fetchBalance: (address: string, decimals?: number) => Promise<string>;
@@ -518,6 +536,101 @@ declare const useSymbolPriceRange: (symbol: string, side: "BUY" | "SELL", price?
 
 declare function useMediaQuery(query: string): boolean;
 
+type posterDataSource = {
+    message?: string;
+    position: {
+        symbol: string;
+        side: "LONG" | "SHORT";
+        /**
+         * The leverage of the position
+         */
+        leverage: number;
+        /**
+         * The unrealized PnL of the position
+         */
+        pnl: number;
+        /**
+         * The return on investment of the position
+         */
+        ROI: number;
+        /**
+         * The informations of the position, such as open price, opened at, mark price, quantity
+         */
+        informations: {
+            title: string;
+            value: string;
+        }[];
+        /**
+         * The quote currency of the position
+         */
+        currency: string;
+    };
+    /**
+     * The domain of the application
+     */
+    domain: string;
+    /**
+     * The update time of the position
+     */
+    updateTime: string;
+};
+type layoutInfo = {
+    width?: number;
+    height?: number;
+    fontSize?: number;
+    color?: string;
+    textAlign?: CanvasTextAlign;
+    textBaseline?: CanvasTextBaseline;
+    position: Partial<{
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    }>;
+};
+type posterLayoutConfig = {
+    message?: layoutInfo;
+    domain?: layoutInfo;
+    position?: layoutInfo;
+    unrealizedPnl?: layoutInfo;
+    informations?: layoutInfo;
+    updateTime?: layoutInfo;
+};
+type drawOptions = {
+    /**
+     * Color of common text
+     */
+    color?: string;
+    /**
+     * Lose color
+     */
+    loseColor?: string;
+    /**
+     * Profit color
+     */
+    profitColor?: string;
+    /**
+     * The brand color of the application
+     */
+    brandColor?: string;
+    backgroundColor?: string;
+    backgroundImg?: string;
+    data?: posterDataSource;
+    layout?: posterLayoutConfig;
+};
+
+/**
+ * Generates a poster image based on position information. You can set the size, background color, font color, font size, and content position of the poster.
+ * @returns
+ */
+declare const usePoster: (trage: HTMLCanvasElement, options: drawOptions) => {
+    readonly error: Error | null;
+    /**
+     * Converts the poster to a data URL
+     */
+    readonly toDataURL: (type?: string, encoderOptions?: number) => string;
+};
+
 declare const cleanStringStyle: (str: string | number) => string;
 
 /** @hidden */
@@ -545,4 +658,4 @@ declare const useCrossSwap: () => any;
 /** @hidden */
 declare const useSwap: () => any;
 
-export { ConfigProviderProps, Favorite, FavoriteTab, MarketsType, OrderParams, OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, Recent, StatusContext, StatusContextState, StatusProvider, UseOrderEntryMetaState, WalletConnectorContext, WsNetworkStatus, cleanStringStyle, useAccount, useAccountInfo, useAccountInstance, useBoolean, useChain, useChains, useCollateral, useConfig, useCrossSwap, useDeposit, useEventEmitter, useFundingRate, useHoldingStream, useIndexPrice, useLazyQuery, useLeverage, useLocalStorage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarkets, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useSessionStorage, useSettleSubscription, useSwap, useSymbolPriceRange, useSymbolsInfo, useTickerStream, useWS, useWalletConnector, useWalletSubscription, useWithdraw, useWooCrossSwapQuery, useWooSwapQuery, useWsStatus, _default as version };
+export { ConfigProviderProps, Favorite, FavoriteTab, MarketsType, OrderParams, OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, Recent, StatusContext, StatusContextState, StatusProvider, UseOrderEntryMetaState, WalletConnectorContext, WsNetworkStatus, cleanStringStyle, drawOptions, parseJSON, useAccount, useAccountInfo, useAccountInstance, useBoolean, useChain, useChains, useCollateral, useConfig, useCrossSwap, useDeposit, useEventEmitter, useFundingRate, useHoldingStream, useIndexPrice, useLazyQuery, useLeverage, useLocalStorage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarkets, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useSessionStorage, useSettleSubscription, useSwap, useSymbolPriceRange, useSymbolsInfo, useTickerStream, useWS, useWalletConnector, useWalletSubscription, useWithdraw, useWooCrossSwapQuery, useWooSwapQuery, useWsStatus, _default as version };

package/dist/index.d.ts

@@ -25,7 +25,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.1.4-alpha.0";
+declare const _default: "1.1.4-alpha.10";
 
 type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
@@ -96,6 +96,8 @@ declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data:
 
 declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value: T) => void];
 
+declare function parseJSON<T>(value: string | null): T | undefined;
+
 declare const useWS: () => WS;
 
 declare const useConfig: <T>(key?: ConfigKey, defaultValue?: T | undefined) => ConfigStore | T;
@@ -179,8 +181,15 @@ type OrderbookData = {
     asks: OrderBookItem[];
     bids: OrderBookItem[];
 };
+/**
+ * Configuration for the Order Book
+ * @level Indicates the number of data entries to return for ask/bid, default is 10
+ * @padding Whether to fill in when the actual data entries are less than the level. If filled, it will add [nan, nan, nan, nan]
+ *          default is true
+ */
 type OrderbookOptions = {
     level?: number;
+    padding?: boolean;
 };
 /**
  * @name useOrderbookStream
@@ -244,21 +253,30 @@ type UseOrderEntryReturn = {
     metaState: UseOrderEntryMetaState;
     symbolConfig: API.SymbolExt;
 };
-type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">> & {};
+type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">>;
 /**
  * Create Order
  * @example
  * ```tsx
+ * import { useOrderEntry } from "@orderly.network/hooks";
+ * import {OrderSide, OrderType} from '@orderly.network/types';
+ *
  * const { formattedOrder, onSubmit, helper } = useOrderEntry({
  *  symbol: "PERP_ETH_USDC",
  *  side: OrderSide.BUY,
  *  order_type: OrderType.LIMIT,
  *  order_price: 10000,
  *  order_quantity: 1,
+ * },{
+ *  // **Note:** it's required
+ *  watchOrderbook: true,
  * });
  * ```
  */
 declare function useOrderEntry(order: OrderParams, options?: UseOrderEntryOptions): UseOrderEntryReturn;
+/**
+ * @deprecated
+ */
 declare function useOrderEntry(symbol: string, side: OrderSide, reduceOnly: boolean): UseOrderEntryReturn;
 
 declare const useSymbolsInfo: () => Record<string, any>;
@@ -475,7 +493,7 @@ declare const useDeposit: (options?: useDepositOptions) => {
     depositFee: bigint;
     /** enquiring depositFee status on chain */
     depositFeeRevalidating: boolean;
-    approve: (amount?: string) => Promise<any>;
+    approve: (amount?: string) => Promise<void | undefined>;
     deposit: () => Promise<any>;
     fetchBalances: (tokens: API.TokenInfo[]) => Promise<void>;
     fetchBalance: (address: string, decimals?: number) => Promise<string>;
@@ -518,6 +536,101 @@ declare const useSymbolPriceRange: (symbol: string, side: "BUY" | "SELL", price?
 
 declare function useMediaQuery(query: string): boolean;
 
+type posterDataSource = {
+    message?: string;
+    position: {
+        symbol: string;
+        side: "LONG" | "SHORT";
+        /**
+         * The leverage of the position
+         */
+        leverage: number;
+        /**
+         * The unrealized PnL of the position
+         */
+        pnl: number;
+        /**
+         * The return on investment of the position
+         */
+        ROI: number;
+        /**
+         * The informations of the position, such as open price, opened at, mark price, quantity
+         */
+        informations: {
+            title: string;
+            value: string;
+        }[];
+        /**
+         * The quote currency of the position
+         */
+        currency: string;
+    };
+    /**
+     * The domain of the application
+     */
+    domain: string;
+    /**
+     * The update time of the position
+     */
+    updateTime: string;
+};
+type layoutInfo = {
+    width?: number;
+    height?: number;
+    fontSize?: number;
+    color?: string;
+    textAlign?: CanvasTextAlign;
+    textBaseline?: CanvasTextBaseline;
+    position: Partial<{
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    }>;
+};
+type posterLayoutConfig = {
+    message?: layoutInfo;
+    domain?: layoutInfo;
+    position?: layoutInfo;
+    unrealizedPnl?: layoutInfo;
+    informations?: layoutInfo;
+    updateTime?: layoutInfo;
+};
+type drawOptions = {
+    /**
+     * Color of common text
+     */
+    color?: string;
+    /**
+     * Lose color
+     */
+    loseColor?: string;
+    /**
+     * Profit color
+     */
+    profitColor?: string;
+    /**
+     * The brand color of the application
+     */
+    brandColor?: string;
+    backgroundColor?: string;
+    backgroundImg?: string;
+    data?: posterDataSource;
+    layout?: posterLayoutConfig;
+};
+
+/**
+ * Generates a poster image based on position information. You can set the size, background color, font color, font size, and content position of the poster.
+ * @returns
+ */
+declare const usePoster: (trage: HTMLCanvasElement, options: drawOptions) => {
+    readonly error: Error | null;
+    /**
+     * Converts the poster to a data URL
+     */
+    readonly toDataURL: (type?: string, encoderOptions?: number) => string;
+};
+
 declare const cleanStringStyle: (str: string | number) => string;
 
 /** @hidden */
@@ -545,4 +658,4 @@ declare const useCrossSwap: () => any;
 /** @hidden */
 declare const useSwap: () => any;
 
-export { ConfigProviderProps, Favorite, FavoriteTab, MarketsType, OrderParams, OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, Recent, StatusContext, StatusContextState, StatusProvider, UseOrderEntryMetaState, WalletConnectorContext, WsNetworkStatus, cleanStringStyle, useAccount, useAccountInfo, useAccountInstance, useBoolean, useChain, useChains, useCollateral, useConfig, useCrossSwap, useDeposit, useEventEmitter, useFundingRate, useHoldingStream, useIndexPrice, useLazyQuery, useLeverage, useLocalStorage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarkets, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useSessionStorage, useSettleSubscription, useSwap, useSymbolPriceRange, useSymbolsInfo, useTickerStream, useWS, useWalletConnector, useWalletSubscription, useWithdraw, useWooCrossSwapQuery, useWooSwapQuery, useWsStatus, _default as version };
+export { ConfigProviderProps, Favorite, FavoriteTab, MarketsType, OrderParams, OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, Recent, StatusContext, StatusContextState, StatusProvider, UseOrderEntryMetaState, WalletConnectorContext, WsNetworkStatus, cleanStringStyle, drawOptions, parseJSON, useAccount, useAccountInfo, useAccountInstance, useBoolean, useChain, useChains, useCollateral, useConfig, useCrossSwap, useDeposit, useEventEmitter, useFundingRate, useHoldingStream, useIndexPrice, useLazyQuery, useLeverage, useLocalStorage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarkets, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useSessionStorage, useSettleSubscription, useSwap, useSymbolPriceRange, useSymbolsInfo, useTickerStream, useWS, useWalletConnector, useWalletSubscription, useWithdraw, useWooCrossSwapQuery, useWooSwapQuery, useWsStatus, _default as version };