@yuants/data-model - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

dist/data-model.d.ts

@@ -34,5 +34,5 @@ /**
 /**
- * all the time is formatted as `yyyy-MM-dd HH:mm:ssXXX`.
+ * all the time is formatted as `yyyy-MM-dd HH:mm:ss.SSSXXX`.
  *
- * e.g. "2023-05-07 12:34:56+08:00"
+ * e.g. "2023-05-07 12:34:56.789+08:00"
  *
@@ -194,3 +194,2 @@ * @public
  *
- * Reference: https://tradelife.feishu.cn/wiki/wikcnkEVzH74fV34NvF5g2xEigb
  * @public
@@ -413,6 +412,2 @@ */
      * 如果此值为空，语义等同于 0
-     *
-     * See [How to Calculate Profit and Loss](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh) for reference.
-     * 参考 [如何计算盈亏](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh)
-     *
      */
@@ -429,5 +424,2 @@ profit_correction?: number;
      * 如果此值为空，语义等同于 "盈亏修正 == 0" 即 "标准盈亏 == 实际盈亏"
-     *
-     * See [How to Calculate Profit and Loss](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh) for reference.
-     * 参考 [如何计算盈亏](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh)
      */
@@ -441,5 +433,2 @@ real_profit?: number;
      * 如果此值为空，语义等同于 1 (即基准货币 == 保证金货币)
-     *
-     * See [How to Calculate Profit and Loss](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh) for reference.
-     * 参考 [如何计算盈亏](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh)
      */
@@ -640,2 +629,10 @@ inferred_base_currency_price?: number;
     /**
+     * The quote currency to price the product.
+     *
+     * e.g. "USD", "CNY", "GBP", "USDT", "BTC", ...etc.
+     *
+     * required after removing `base_currency` and `quoted_currency`
+     */
+    quote_currency?: string;
+    /**
      * Base Currency
@@ -649,2 +646,4 @@ * 基准货币 (Base Currency)
      * e.g. GBPJPY 的 base_currency 为 GBP; USDCAD 的 base_currency 为 USD.
+     *
+     * @deprecated use quote_currency instead
      */
@@ -664,2 +663,4 @@ base_currency: string;
      * 对于非外汇品种，quoted_currency 应当为空。
+     *
+     * @deprecated use quote_currency instead
      */
@@ -724,10 +725,16 @@ quoted_currency?: string;
      * - If this value is `BASE` an additional division by the "closing price" of this product is required in the standard profit formula.
+     *
+     * @deprecated use value_scale_unit instead
      */
     value_unit?: string;
     /**
+     * Unit of value scale.
+     *
+     * - Leave empty to use the product itself.
+     * - If the value is equal to currency, it means that the 1 volume is based on the currency.
+     */
+    value_scale_unit?: string;
+    /**
      * Margin rate
      * 保证金率
-     *
-     * Margin calculation reference [How to calculate margin](https://tradelife.feishu.cn/wiki/wikcnEVBM0RQ7pmbNZUxMV8viRg)
-     * 保证金计算参考 [如何计算保证金](https://tradelife.feishu.cn/wiki/wikcnEVBM0RQ7pmbNZUxMV8viRg)
      */
@@ -734,0 +741,0 @@ margin_rate?: number;

dist/utils.js

@@ -94,5 +94,5 @@ import { format } from 'date-fns';
 /**
- * all the time is formatted as `yyyy-MM-dd HH:mm:ssXXX`.
+ * all the time is formatted as `yyyy-MM-dd HH:mm:ss.SSSXXX`.
  *
- * e.g. "2023-05-07 12:34:56+08:00"
+ * e.g. "2023-05-07 12:34:56.789+08:00"
  *
@@ -99,0 +99,0 @@ * @public

lib/interfaces.d.ts

@@ -15,2 +15,10 @@ /**
     /**
+     * The quote currency to price the product.
+     *
+     * e.g. "USD", "CNY", "GBP", "USDT", "BTC", ...etc.
+     *
+     * required after removing `base_currency` and `quoted_currency`
+     */
+    quote_currency?: string;
+    /**
      * Base Currency
@@ -24,2 +32,4 @@ * 基准货币 (Base Currency)
      * e.g. GBPJPY 的 base_currency 为 GBP; USDCAD 的 base_currency 为 USD.
+     *
+     * @deprecated use quote_currency instead
      */
@@ -39,2 +49,4 @@ base_currency: string;
      * 对于非外汇品种，quoted_currency 应当为空。
+     *
+     * @deprecated use quote_currency instead
      */
@@ -99,10 +111,16 @@ quoted_currency?: string;
      * - If this value is `BASE` an additional division by the "closing price" of this product is required in the standard profit formula.
+     *
+     * @deprecated use value_scale_unit instead
      */
     value_unit?: string;
     /**
+     * Unit of value scale.
+     *
+     * - Leave empty to use the product itself.
+     * - If the value is equal to currency, it means that the 1 volume is based on the currency.
+     */
+    value_scale_unit?: string;
+    /**
      * Margin rate
      * 保证金率
-     *
-     * Margin calculation reference [How to calculate margin](https://tradelife.feishu.cn/wiki/wikcnEVBM0RQ7pmbNZUxMV8viRg)
-     * 保证金计算参考 [如何计算保证金](https://tradelife.feishu.cn/wiki/wikcnEVBM0RQ7pmbNZUxMV8viRg)
      */
@@ -485,6 +503,2 @@ margin_rate?: number;
      * 如果此值为空，语义等同于 0
-     *
-     * See [How to Calculate Profit and Loss](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh) for reference.
-     * 参考 [如何计算盈亏](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh)
-     *
      */
@@ -501,5 +515,2 @@ profit_correction?: number;
      * 如果此值为空，语义等同于 "盈亏修正 == 0" 即 "标准盈亏 == 实际盈亏"
-     *
-     * See [How to Calculate Profit and Loss](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh) for reference.
-     * 参考 [如何计算盈亏](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh)
      */
@@ -513,5 +524,2 @@ real_profit?: number;
      * 如果此值为空，语义等同于 1 (即基准货币 == 保证金货币)
-     *
-     * See [How to Calculate Profit and Loss](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh) for reference.
-     * 参考 [如何计算盈亏](https://tradelife.feishu.cn/wiki/wikcnRNzWSF7jtkH8nGruaMhhlh)
      */
@@ -747,3 +755,2 @@ inferred_base_currency_price?: number;
  *
- * Reference: https://tradelife.feishu.cn/wiki/wikcnkEVzH74fV34NvF5g2xEigb
  * @public
@@ -750,0 +757,0 @@ */

lib/utils.d.ts

@@ -40,5 +40,5 @@ import { Observable } from 'rxjs';
 /**
- * all the time is formatted as `yyyy-MM-dd HH:mm:ssXXX`.
+ * all the time is formatted as `yyyy-MM-dd HH:mm:ss.SSSXXX`.
  *
- * e.g. "2023-05-07 12:34:56+08:00"
+ * e.g. "2023-05-07 12:34:56.789+08:00"
  *
@@ -45,0 +45,0 @@ * @public

lib/utils.js

@@ -102,5 +102,5 @@ "use strict";
 /**
- * all the time is formatted as `yyyy-MM-dd HH:mm:ssXXX`.
+ * all the time is formatted as `yyyy-MM-dd HH:mm:ss.SSSXXX`.
  *
- * e.g. "2023-05-07 12:34:56+08:00"
+ * e.g. "2023-05-07 12:34:56.789+08:00"
  *
@@ -107,0 +107,0 @@ * @public

package.json

 {
 	"name": "@yuants/data-model",
-	"version": "0.2.1",
+	"version": "0.3.0",
 	"main": "lib/index.js",
@@ -5,0 +5,0 @@ "module": "dist/index.js",

temp/data-model.api.md

@@ -150,2 +150,3 @@ ## API Report File for "@yuants/data-model"
     allow_short?: boolean;
+    // @deprecated
     base_currency: string;
@@ -161,2 +162,4 @@ datasource_id: string;
     product_id: string;
+    quote_currency?: string;
+    // @deprecated
     quoted_currency?: string;
@@ -166,4 +169,6 @@ spread?: number;
     value_scale?: number;
+    value_scale_unit?: string;
     // @deprecated
     value_speed?: number;
+    // @deprecated
     value_unit?: string;
@@ -170,0 +175,0 @@ volume_based_cost?: number;

temp/package-deps.json

 {
-    "libraries/data-model/CHANGELOG.json": "04e67bff348e67d2ba559cdb8fb3b44278d4fc14",
-    "libraries/data-model/CHANGELOG.md": "eb47b87b2b1bfd92f2efa8e6d8f47d30e7a0b43d",
+    "libraries/data-model/CHANGELOG.json": "c57f40f9deffed4a96a69ccb93bb2943aeaef173",
+    "libraries/data-model/CHANGELOG.md": "ad7db2d1e24185f165be6569e65df8a8d82de1fd",
     "libraries/data-model/api-extractor.json": "62f4fd324425b9a235f0c117975967aab09ced0c",
@@ -8,8 +8,8 @@ "libraries/data-model/config/jest.config.json": "4bb17bde3ee911163a3edb36a6eb71491d80b1bd",
     "libraries/data-model/config/typescript.json": "854907e8a821f2050f6533368db160c649c25348",
-    "libraries/data-model/etc/data-model.api.md": "731523226202dfd693733c590127881b066053e3",
-    "libraries/data-model/package.json": "aeddad29b67ccfbe8a6d23f41082d04f26aea416",
+    "libraries/data-model/etc/data-model.api.md": "a70a3a08a5b78ddbdc846fb7e5b5e0555986f9d1",
+    "libraries/data-model/package.json": "a8263e541b39879685b174c171a74f652318e52a",
     "libraries/data-model/src/index.ts": "49fc2befb673b800db4cdba4235ab4ddb6736788",
-    "libraries/data-model/src/interfaces.ts": "e4d4cc45d495aca3f667cb72b16f0058a686633e",
+    "libraries/data-model/src/interfaces.ts": "daa2ef73f0e53bbd2bbf11d4835512e7901ae051",
     "libraries/data-model/src/utils.test.ts": "d4a493922e5c87b47bf59b064fcb807a1411310c",
-    "libraries/data-model/src/utils.ts": "c7f7d37e9fef2f31dd9eb778c29d9b17d27966a7",
+    "libraries/data-model/src/utils.ts": "b0bcb0f8cb0394a74d53ad5ba05a1aae13f322ef",
     "libraries/data-model/tsconfig.json": "22f94ca28b507f8ddcc21b9053158eefd3f726a9",
@@ -16,0 +16,0 @@ "libraries/data-model/.rush/temp/shrinkwrap-deps.json": "fcb3fca669b68350f864742e0343d7dabb11d9a5",

No alert changes

Improved metrics

Total package byte prevSize

314728

increased by0.01%

Lines of code

6324

increased by1.05%

No dependency changes