@orderly.network/hooks 2.3.2 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/index.d.mts +21 -3
  2. package/dist/index.d.ts +21 -3
  3. package/dist/index.js +995 -555
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +996 -556
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +10 -10
package/dist/index.d.mts CHANGED
@@ -31,7 +31,7 @@ declare global {
31
31
  };
32
32
  }
33
33
  }
34
- declare const _default: "2.3.2";
34
+ declare const _default: "2.4.0";
35
35
 
36
36
  declare const fetcher: (url: string, init: RequestInit | undefined, queryOptions: useQueryOptions<any>) => Promise<any>;
37
37
  type useQueryOptions<T> = SWRConfiguration & {
@@ -950,6 +950,12 @@ type OrderValidationItem = {
950
950
  type: "max" | "min";
951
951
  message: string;
952
952
  value: number | string;
953
+ } | {
954
+ type: "range";
955
+ message: string;
956
+ value?: never;
957
+ min: number | string;
958
+ max: number | string;
953
959
  };
954
960
  type OrderValidationResult = {
955
961
  [P in keyof OrderlyOrder]?: OrderValidationItem;
@@ -959,6 +965,8 @@ type ValuesDepConfig = {
959
965
  maxQty: number;
960
966
  markPrice: number;
961
967
  estSlippage?: number | null;
968
+ /** [ask0, bid0] */
969
+ askAndBid?: number[];
962
970
  };
963
971
  interface OrderCreator<T> {
964
972
  create: (values: T, configs: ValuesDepConfig) => T;
@@ -1396,8 +1404,12 @@ declare const DefaultLayoutConfig: PosterLayoutConfig;
1396
1404
  type FullOrderState$1 = OrderlyOrder;
1397
1405
 
1398
1406
  declare const cleanStringStyle: (str: string | number) => string;
1407
+ /**
1408
+ * format number
1409
+ * TODO: refactor this
1410
+ */
1399
1411
  declare function formatNumber(qty?: string | number, dp?: number | string): string | undefined;
1400
- declare function calculate(values: Partial<FullOrderState$1>, fieldName: "symbol" | "order_type" | "order_type_ext" | "order_price" | "order_quantity" | "order_amount" | "visible_quantity" | "side" | "reduce_only" | "slippage" | "order_tag" | "level" | "post_only_adjust" | "total" | "algo_type" | "trigger_price_type" | "trigger_price" | "child_orders" | "tp_pnl" | "tp_offset" | "tp_offset_percentage" | "tp_ROI" | "tp_trigger_price" | "sl_pnl" | "sl_offset" | "sl_offset_percentage" | "sl_ROI" | "sl_trigger_price" | "quantity" | "price" | "type", value: any, markPrice: number, config: API.SymbolExt): Partial<FullOrderState$1>;
1412
+ declare function calculate(values: Partial<FullOrderState$1>, fieldName: keyof FullOrderState$1, value: any, markPrice: number, config: API.SymbolExt): Partial<FullOrderState$1>;
1401
1413
 
1402
1414
  /**
1403
1415
  * get the min notional for the order
@@ -1412,7 +1424,7 @@ declare function getMinNotional(props: {
1412
1424
  quote_tick?: number;
1413
1425
  }): string | undefined;
1414
1426
  /**
1415
- * @deprecated please use getMinNotional instead
1427
+ * @deprecated please use getMinNotional instead, it will be removed in next major version
1416
1428
  */
1417
1429
  declare function checkNotional(props: {
1418
1430
  base_tick: number;
@@ -1885,11 +1897,14 @@ declare const useOrderEntryNextInternal: (symbol: string, options?: {
1885
1897
  readonly generateOrder: (creator: OrderCreator<any>, options: {
1886
1898
  maxQty: number;
1887
1899
  markPrice: number;
1900
+ estSlippage?: number | null;
1901
+ askAndBid?: number[];
1888
1902
  }) => any;
1889
1903
  readonly validate: (order: Partial<OrderlyOrder>, creator: OrderCreator<any>, options: {
1890
1904
  maxQty: number;
1891
1905
  markPrice: number;
1892
1906
  estSlippage?: number | null;
1907
+ askAndBid?: number[];
1893
1908
  }) => Promise<{
1894
1909
  [x: string]: OrderValidationItem | undefined;
1895
1910
  }>;
@@ -2042,6 +2057,9 @@ declare const useRestrictedInfo: (options?: RestrictedInfoOptions) => {
2042
2057
  ip: string;
2043
2058
  brokerName: string;
2044
2059
  }) => ReactNode);
2060
+ canUnblock: boolean;
2061
+ accessRestricted: any;
2062
+ setAccessRestricted: (value: boolean | undefined) => void;
2045
2063
  };
2046
2064
 
2047
2065
  type QueryOptions<T> = SWRConfiguration & {
package/dist/index.d.ts CHANGED
@@ -31,7 +31,7 @@ declare global {
31
31
  };
32
32
  }
33
33
  }
34
- declare const _default: "2.3.2";
34
+ declare const _default: "2.4.0";
35
35
 
36
36
  declare const fetcher: (url: string, init: RequestInit | undefined, queryOptions: useQueryOptions<any>) => Promise<any>;
37
37
  type useQueryOptions<T> = SWRConfiguration & {
@@ -950,6 +950,12 @@ type OrderValidationItem = {
950
950
  type: "max" | "min";
951
951
  message: string;
952
952
  value: number | string;
953
+ } | {
954
+ type: "range";
955
+ message: string;
956
+ value?: never;
957
+ min: number | string;
958
+ max: number | string;
953
959
  };
954
960
  type OrderValidationResult = {
955
961
  [P in keyof OrderlyOrder]?: OrderValidationItem;
@@ -959,6 +965,8 @@ type ValuesDepConfig = {
959
965
  maxQty: number;
960
966
  markPrice: number;
961
967
  estSlippage?: number | null;
968
+ /** [ask0, bid0] */
969
+ askAndBid?: number[];
962
970
  };
963
971
  interface OrderCreator<T> {
964
972
  create: (values: T, configs: ValuesDepConfig) => T;
@@ -1396,8 +1404,12 @@ declare const DefaultLayoutConfig: PosterLayoutConfig;
1396
1404
  type FullOrderState$1 = OrderlyOrder;
1397
1405
 
1398
1406
  declare const cleanStringStyle: (str: string | number) => string;
1407
+ /**
1408
+ * format number
1409
+ * TODO: refactor this
1410
+ */
1399
1411
  declare function formatNumber(qty?: string | number, dp?: number | string): string | undefined;
1400
- declare function calculate(values: Partial<FullOrderState$1>, fieldName: "symbol" | "order_type" | "order_type_ext" | "order_price" | "order_quantity" | "order_amount" | "visible_quantity" | "side" | "reduce_only" | "slippage" | "order_tag" | "level" | "post_only_adjust" | "total" | "algo_type" | "trigger_price_type" | "trigger_price" | "child_orders" | "tp_pnl" | "tp_offset" | "tp_offset_percentage" | "tp_ROI" | "tp_trigger_price" | "sl_pnl" | "sl_offset" | "sl_offset_percentage" | "sl_ROI" | "sl_trigger_price" | "quantity" | "price" | "type", value: any, markPrice: number, config: API.SymbolExt): Partial<FullOrderState$1>;
1412
+ declare function calculate(values: Partial<FullOrderState$1>, fieldName: keyof FullOrderState$1, value: any, markPrice: number, config: API.SymbolExt): Partial<FullOrderState$1>;
1401
1413
 
1402
1414
  /**
1403
1415
  * get the min notional for the order
@@ -1412,7 +1424,7 @@ declare function getMinNotional(props: {
1412
1424
  quote_tick?: number;
1413
1425
  }): string | undefined;
1414
1426
  /**
1415
- * @deprecated please use getMinNotional instead
1427
+ * @deprecated please use getMinNotional instead, it will be removed in next major version
1416
1428
  */
1417
1429
  declare function checkNotional(props: {
1418
1430
  base_tick: number;
@@ -1885,11 +1897,14 @@ declare const useOrderEntryNextInternal: (symbol: string, options?: {
1885
1897
  readonly generateOrder: (creator: OrderCreator<any>, options: {
1886
1898
  maxQty: number;
1887
1899
  markPrice: number;
1900
+ estSlippage?: number | null;
1901
+ askAndBid?: number[];
1888
1902
  }) => any;
1889
1903
  readonly validate: (order: Partial<OrderlyOrder>, creator: OrderCreator<any>, options: {
1890
1904
  maxQty: number;
1891
1905
  markPrice: number;
1892
1906
  estSlippage?: number | null;
1907
+ askAndBid?: number[];
1893
1908
  }) => Promise<{
1894
1909
  [x: string]: OrderValidationItem | undefined;
1895
1910
  }>;
@@ -2042,6 +2057,9 @@ declare const useRestrictedInfo: (options?: RestrictedInfoOptions) => {
2042
2057
  ip: string;
2043
2058
  brokerName: string;
2044
2059
  }) => ReactNode);
2060
+ canUnblock: boolean;
2061
+ accessRestricted: any;
2062
+ setAccessRestricted: (value: boolean | undefined) => void;
2045
2063
  };
2046
2064
 
2047
2065
  type QueryOptions<T> = SWRConfiguration & {