feat: add useParam* hooks and encodePath, decodePath (#36)

@libs/global.ts

@@ -8,10 +8,10 @@ export const global = {
   useMemoAsync,
   useAccountInfo,
   useLog,
-  useParamProduct,
-  useParamOHLC,
   useProduct,
   useOHLC,
+  decodePath,
+  encodePath,
   useRecordTable,
   useExchange,
   useSeries,

@libs/index.ts

@@ -6,8 +6,6 @@ export const useMemo = global.useMemo;
 export const useMemoAsync = global.useMemoAsync;
 export const useAccountInfo = global.useAccountInfo;
 export const useLog = global.useLog;
-export const useParamProduct = global.useParamProduct;
-export const useParamOHLC = global.useParamOHLC;
 export const useProduct = global.useProduct;
 export const useOHLC = global.useOHLC;
 export const useRecordTable = global.useRecordTable;

@libs/utils/index.ts

@@ -4,6 +4,8 @@ export * from "./useCounterParty";
 export * from "./useDelay";
 export * from "./useParamBoolean";
 export * from "./useParamNumber";
+export * from "./useParamOHLC";
+export * from "./useParamProduct";
 export * from "./useParamString";
 export * from "./usePositionLimit";
 export * from "./useRuleEffect";

@libs/utils/useParamOHLC.ts

@@ -0,0 +1,19 @@
+/**
+ * Use OHLC with parameter
+ */
+export const useParamOHLC = (key: string) => {
+  const OHLCKey = useParamSchema<string>(key, {
+    type: "string",
+    format: "OHLC-key",
+  });
+  const { datasource_id, product_id, period_in_sec } = useMemo(() => {
+    const [datasource_id = "", product_id = "", _period_in_sec] = decodePath(
+      OHLCKey || ""
+    );
+    const period_in_sec = +_period_in_sec;
+    return { datasource_id, product_id, period_in_sec };
+  }, []);
+
+  const periods = useOHLC(datasource_id, product_id, period_in_sec);
+  return { datasource_id, product_id, period_in_sec, ...periods };
+};

@libs/utils/useParamProduct.ts

@@ -0,0 +1,16 @@
+/**
+ * Use parameter as Product
+ * @param key - parameter's name
+ */
+export const useParamProduct = (key: string): IProduct => {
+  const productKey = useParamSchema<string>(key, {
+    type: "string",
+    format: "product-key",
+  });
+
+  const { datasource_id, product_id } = useMemo(() => {
+    const [datasource_id = "", product_id = ""] = decodePath(productKey || "");
+    return { datasource_id, product_id };
+  }, []);
+  return useProduct(datasource_id, product_id);
+};

@libs/utils/usePositionLimit.ts

@@ -1,3 +1,4 @@
+import { useSinglePosition } from "@libs";
 /**
  * Derive a PositionLimit account from the source account.
  *

@models/CCI-trending.ts

@@ -1,4 +1,10 @@
-import { useATR, useCCI, useRef, useSimplePositionManager } from "@libs";
+import {
+  useATR,
+  useCCI,
+  useParamOHLC,
+  useRef,
+  useSimplePositionManager,
+} from "@libs";
 
 /**
  * CCI 顺势交易策略

@models/R-Breaker.ts

@@ -1,6 +1,6 @@
 // R-Breaker 策略
 // 高低周期的回转策略，根据高周期计算几个枢轴价位，然后在低周期上进行交易
-
+import { useParamOHLC, useSinglePosition } from "@libs";
 export default () => {
   // 设定参数
   const { product_id, close: C } = useParamOHLC("低周期"); // e.g. 1min

@models/consecutive-up-down.ts

@@ -4,7 +4,12 @@
 // 进入多头时平掉空头，进入空头时平掉多头
 // X 和 Y 输入在策略设置中进行管理
 // 并在附图中绘制连续上涨/下跌的信号的直方图
-import { useSeriesMap } from "@libs";
+import {
+  useParamNumber,
+  useSeriesMap,
+  useSinglePosition,
+  useParamOHLC,
+} from "@libs";
 
 export default () => {
   const { product_id, close } = useParamOHLC("SomeKey");

@models/double-ma.ts

@@ -1,7 +1,7 @@
 // 双均线策略 (Double Moving Average)
 // 当短期均线由下向上穿越长期均线时做多 (金叉)
 // 当短期均线由上向下穿越长期均线时做空 (死叉)
-import { useSMA, useSimplePositionManager } from "@libs";
+import { useParamOHLC, useSMA, useSimplePositionManager } from "@libs";
 
 export default () => {
   // 使用收盘价序列

@models/dual-thrust.ts

@@ -5,6 +5,7 @@ import {
   useMAX,
   useMIN,
   useParamNumber,
+  useParamOHLC,
   useSimplePositionManager,
 } from "@libs";
 

@models/greedy.ts

@@ -1,3 +1,4 @@
+import { useParamOHLC, useSinglePosition } from "@libs";
 // 贪心策略
 // 如果当前开盘价与前一根K线的高点或低点之间存在差距，贪婪策略会打开一个初始订单。如果开盘价大于前一个高点，则策略做多，如果开盘价低于前一个K线的低点，则开空仓。
 // 开仓后，只要蜡烛的颜色与开仓一致，就会继续向同一方向填单。如果当前仓位是多头，将为每个后续的绿色蜡烛创建新的多头订单，反之亦然。这将继续进行，直到出现不同颜色的蜡烛

@models/hp-sma.ts

@@ -2,6 +2,7 @@
 import {
   useHPFilter,
   useParamNumber,
+  useParamOHLC,
   useSMA,
   useSimplePositionManager,
 } from "@libs";

@models/super-trend.ts

@@ -6,7 +6,13 @@
 // 下轨为上一根K线的(close+open)/2 - A * atr
 // 当价格上穿到上轨时，进入突破模式，当下穿上轨时，进入下跌模式
 // 并画出上轨和下轨
-import { useATR, useParamNumber, useSeriesMap } from "@libs";
+import {
+  useATR,
+  useParamNumber,
+  useParamOHLC,
+  useSeriesMap,
+  useSinglePosition,
+} from "@libs";
 
 export default () => {
   const { product_id, close, open, high, low } = useParamOHLC("SomeKey");

@models/turtle-long.ts

@@ -8,6 +8,7 @@ import {
   useMAX,
   useMIN,
   useParamNumber,
+  useParamOHLC,
   useRuleEffect,
   useSeriesMap,
   useSinglePosition,

global.d.ts

@@ -472,33 +472,6 @@ declare const useMemoAsync: <T>(
  * @see https://json-schema.org/ for JSON Schema Specification
  */
 declare const useParamSchema: <T>(key: string, schema: any) => T;
-/**
- * Use an application parameter (number)
- *
- * @param key - The key of the parameter
- * @param defaultValue - The default value of the parameter
- * @returns The value of the parameter
- * @deprecated import from "@libs" instead
- */
-declare const useParamNumber: (key: string, defaultValue?: number) => number;
-/**
- * Use an application parameter (boolean)
- *
- * @param key - The key of the parameter
- * @param defaultValue - The default value of the parameter
- * @returns The value of the parameter
- * @deprecated import from "@libs" instead
- */
-declare const useParamBoolean: (key: string, defaultValue?: boolean) => boolean;
-/**
- * Use an application parameter (string)
- *
- * @param key - The key of the parameter
- * @param defaultValue - The default value of the parameter
- * @returns The value of the parameter
- * @deprecated import from "@libs" instead
- */
-declare const useParamString: (key: string, defaultValue?: string) => string;
 
 // Series Hook
 /** A series is a number[] with some additional fields */
@@ -521,8 +494,7 @@ declare const useProduct: (
   datasource_id: string,
   product_id: string
 ) => IProduct;
-/** Use product parameters */
-declare const useParamProduct: (key: string) => IProduct;
+
 /**
  * Use OHLC Period Data
  * @param datasource_id - Data source ID
@@ -541,34 +513,14 @@ declare const useOHLC: (
   close: Series;
   volume: Series;
 };
-/** Use OHLC data */
-declare const useParamOHLC: (key: string) => ReturnType<typeof useOHLC> & {
-  datasource_id: string;
-  product_id: string;
-  period_in_sec: number;
-};
+
 /** Use Account Info */
 declare const useAccountInfo: (options?: {
   account_id?: string;
   currency?: string;
   leverage?: number;
   initial_balance?: number;
 }) => IAccountInfo;
-/**
- * Use a position manager for a specified product and direction
- */
-declare const useSinglePosition: (
-  product_id: string,
-  variant: PositionVariant,
-  account_id?: string
-) => {
-  targetVolume: number;
-  takeProfitPrice: number;
-  stopLossPrice: number;
-  setTargetVolume: (v: number) => void;
-  setTakeProfitPrice: (v: number) => void;
-  setStopLossPrice: (v: number) => void;
-} & IPosition;
 
 /** Use Exchange */
 declare const useExchange: () => {
@@ -600,6 +552,22 @@ declare const roundToStep: (
   step: number,
   roundFn?: ((x: number) => number) | undefined
 ) => number;
+
+/**
+ * convert params to path.
+ * Path is splitted by `/`.
+ * Escape to `\/` if a param including `/`.
+ */
+declare const encodePath: (...params: any[]) => string;
+
+/**
+ * convert path to params.
+ * Path is splitted by `/`.
+ * Escape to `\/` if a param including `/`.
+ * @public
+ */
+declare const decodePath: (path: string) => string[];
+
 declare const getProfit: (
   product: IProduct,
   openPrice: number,