backtest-kit 1.4.13 → 1.4.14

package/build/index.cjs

@@ -13098,24 +13098,26 @@ class BacktestUtils {
         /**
          * Saves strategy report to disk.
          *
+         * @param symbol - Trading pair symbol
          * @param strategyName - Strategy name to save report for
          * @param path - Optional directory path to save report (default: "./dump/backtest")
          *
          * @example
          * ```typescript
          * // Save to default path: ./dump/backtest/my-strategy.md
-         * await Backtest.dump("my-strategy");
+         * await Backtest.dump("BTCUSDT", "my-strategy");
          *
          * // Save to custom path: ./custom/path/my-strategy.md
-         * await Backtest.dump("my-strategy", "./custom/path");
+         * await Backtest.dump("BTCUSDT", "my-strategy", "./custom/path");
          * ```
          */
-        this.dump = async (strategyName, path) => {
+        this.dump = async (symbol, strategyName, path) => {
             backtest$1.loggerService.info(BACKTEST_METHOD_NAME_DUMP, {
+                symbol,
                 strategyName,
                 path,
             });
-            await backtest$1.backtestMarkdownService.dump(strategyName, path);
+            await backtest$1.backtestMarkdownService.dump(symbol, strategyName, path);
         };
     }
 }
@@ -13311,24 +13313,26 @@ class LiveUtils {
         /**
          * Saves strategy report to disk.
          *
+         * @param symbol - Trading pair symbol
          * @param strategyName - Strategy name to save report for
          * @param path - Optional directory path to save report (default: "./dump/live")
          *
          * @example
          * ```typescript
          * // Save to default path: ./dump/live/my-strategy.md
-         * await Live.dump("my-strategy");
+         * await Live.dump("BTCUSDT", "my-strategy");
          *
          * // Save to custom path: ./custom/path/my-strategy.md
-         * await Live.dump("my-strategy", "./custom/path");
+         * await Live.dump("BTCUSDT", "my-strategy", "./custom/path");
          * ```
          */
-        this.dump = async (strategyName, path) => {
+        this.dump = async (symbol, strategyName, path) => {
             backtest$1.loggerService.info(LIVE_METHOD_NAME_DUMP, {
+                symbol,
                 strategyName,
                 path,
             });
-            await backtest$1.liveMarkdownService.dump(strategyName, path);
+            await backtest$1.liveMarkdownService.dump(symbol, strategyName, path);
         };
     }
 }
@@ -13422,24 +13426,26 @@ class ScheduleUtils {
         /**
          * Saves strategy report to disk.
          *
+         * @param symbol - Trading pair symbol
          * @param strategyName - Strategy name to save report for
          * @param path - Optional directory path to save report (default: "./dump/schedule")
          *
          * @example
          * ```typescript
          * // Save to default path: ./dump/schedule/my-strategy.md
-         * await Schedule.dump("my-strategy");
+         * await Schedule.dump("BTCUSDT", "my-strategy");
          *
          * // Save to custom path: ./custom/path/my-strategy.md
-         * await Schedule.dump("my-strategy", "./custom/path");
+         * await Schedule.dump("BTCUSDT", "my-strategy", "./custom/path");
          * ```
          */
-        this.dump = async (strategyName, path) => {
+        this.dump = async (symbol, strategyName, path) => {
             backtest$1.loggerService.info(SCHEDULE_METHOD_NAME_DUMP, {
+                symbol,
                 strategyName,
                 path,
             });
-            await backtest$1.scheduleMarkdownService.dump(strategyName, path);
+            await backtest$1.scheduleMarkdownService.dump(symbol, strategyName, path);
         };
     }
 }
@@ -13551,20 +13557,21 @@ class Performance {
      * Creates directory if it doesn't exist.
      * Default path: ./dump/performance/{strategyName}.md
      *
+     * @param symbol - Trading pair symbol
      * @param strategyName - Strategy name to save report for
      * @param path - Optional custom directory path
      *
      * @example
      * ```typescript
      * // Save to default path: ./dump/performance/my-strategy.md
-     * await Performance.dump("my-strategy");
+     * await Performance.dump("BTCUSDT", "my-strategy");
      *
      * // Save to custom path: ./reports/perf/my-strategy.md
-     * await Performance.dump("my-strategy", "./reports/perf");
+     * await Performance.dump("BTCUSDT", "my-strategy", "./reports/perf");
      * ```
      */
-    static async dump(strategyName, path = "./dump/performance") {
-        return backtest$1.performanceMarkdownService.dump(strategyName, path);
+    static async dump(symbol, strategyName, path = "./dump/performance") {
+        return backtest$1.performanceMarkdownService.dump(symbol, strategyName, path);
     }
 }
 

package/build/index.mjs

@@ -13096,24 +13096,26 @@ class BacktestUtils {
         /**
          * Saves strategy report to disk.
          *
+         * @param symbol - Trading pair symbol
          * @param strategyName - Strategy name to save report for
          * @param path - Optional directory path to save report (default: "./dump/backtest")
          *
          * @example
          * ```typescript
          * // Save to default path: ./dump/backtest/my-strategy.md
-         * await Backtest.dump("my-strategy");
+         * await Backtest.dump("BTCUSDT", "my-strategy");
          *
          * // Save to custom path: ./custom/path/my-strategy.md
-         * await Backtest.dump("my-strategy", "./custom/path");
+         * await Backtest.dump("BTCUSDT", "my-strategy", "./custom/path");
          * ```
          */
-        this.dump = async (strategyName, path) => {
+        this.dump = async (symbol, strategyName, path) => {
             backtest$1.loggerService.info(BACKTEST_METHOD_NAME_DUMP, {
+                symbol,
                 strategyName,
                 path,
             });
-            await backtest$1.backtestMarkdownService.dump(strategyName, path);
+            await backtest$1.backtestMarkdownService.dump(symbol, strategyName, path);
         };
     }
 }
@@ -13309,24 +13311,26 @@ class LiveUtils {
         /**
          * Saves strategy report to disk.
          *
+         * @param symbol - Trading pair symbol
          * @param strategyName - Strategy name to save report for
          * @param path - Optional directory path to save report (default: "./dump/live")
          *
          * @example
          * ```typescript
          * // Save to default path: ./dump/live/my-strategy.md
-         * await Live.dump("my-strategy");
+         * await Live.dump("BTCUSDT", "my-strategy");
          *
          * // Save to custom path: ./custom/path/my-strategy.md
-         * await Live.dump("my-strategy", "./custom/path");
+         * await Live.dump("BTCUSDT", "my-strategy", "./custom/path");
          * ```
          */
-        this.dump = async (strategyName, path) => {
+        this.dump = async (symbol, strategyName, path) => {
             backtest$1.loggerService.info(LIVE_METHOD_NAME_DUMP, {
+                symbol,
                 strategyName,
                 path,
             });
-            await backtest$1.liveMarkdownService.dump(strategyName, path);
+            await backtest$1.liveMarkdownService.dump(symbol, strategyName, path);
         };
     }
 }
@@ -13420,24 +13424,26 @@ class ScheduleUtils {
         /**
          * Saves strategy report to disk.
          *
+         * @param symbol - Trading pair symbol
          * @param strategyName - Strategy name to save report for
          * @param path - Optional directory path to save report (default: "./dump/schedule")
          *
          * @example
          * ```typescript
          * // Save to default path: ./dump/schedule/my-strategy.md
-         * await Schedule.dump("my-strategy");
+         * await Schedule.dump("BTCUSDT", "my-strategy");
          *
          * // Save to custom path: ./custom/path/my-strategy.md
-         * await Schedule.dump("my-strategy", "./custom/path");
+         * await Schedule.dump("BTCUSDT", "my-strategy", "./custom/path");
          * ```
          */
-        this.dump = async (strategyName, path) => {
+        this.dump = async (symbol, strategyName, path) => {
             backtest$1.loggerService.info(SCHEDULE_METHOD_NAME_DUMP, {
+                symbol,
                 strategyName,
                 path,
             });
-            await backtest$1.scheduleMarkdownService.dump(strategyName, path);
+            await backtest$1.scheduleMarkdownService.dump(symbol, strategyName, path);
         };
     }
 }
@@ -13549,20 +13555,21 @@ class Performance {
      * Creates directory if it doesn't exist.
      * Default path: ./dump/performance/{strategyName}.md
      *
+     * @param symbol - Trading pair symbol
      * @param strategyName - Strategy name to save report for
      * @param path - Optional custom directory path
      *
      * @example
      * ```typescript
      * // Save to default path: ./dump/performance/my-strategy.md
-     * await Performance.dump("my-strategy");
+     * await Performance.dump("BTCUSDT", "my-strategy");
      *
      * // Save to custom path: ./reports/perf/my-strategy.md
-     * await Performance.dump("my-strategy", "./reports/perf");
+     * await Performance.dump("BTCUSDT", "my-strategy", "./reports/perf");
      * ```
      */
-    static async dump(strategyName, path = "./dump/performance") {
-        return backtest$1.performanceMarkdownService.dump(strategyName, path);
+    static async dump(symbol, strategyName, path = "./dump/performance") {
+        return backtest$1.performanceMarkdownService.dump(symbol, strategyName, path);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backtest-kit",
-  "version": "1.4.13",
+  "version": "1.4.14",
   "description": "A TypeScript library for trading system backtest",
   "author": {
     "name": "Petr Tripolsky",

package/types.d.ts

@@ -5213,19 +5213,20 @@ declare class BacktestUtils {
     /**
      * Saves strategy report to disk.
      *
+     * @param symbol - Trading pair symbol
      * @param strategyName - Strategy name to save report for
      * @param path - Optional directory path to save report (default: "./dump/backtest")
      *
      * @example
      * ```typescript
      * // Save to default path: ./dump/backtest/my-strategy.md
-     * await Backtest.dump("my-strategy");
+     * await Backtest.dump("BTCUSDT", "my-strategy");
      *
      * // Save to custom path: ./custom/path/my-strategy.md
-     * await Backtest.dump("my-strategy", "./custom/path");
+     * await Backtest.dump("BTCUSDT", "my-strategy", "./custom/path");
      * ```
      */
-    dump: (strategyName: StrategyName, path?: string) => Promise<void>;
+    dump: (symbol: string, strategyName: StrategyName, path?: string) => Promise<void>;
 }
 /**
  * Singleton instance of BacktestUtils for convenient backtest operations.
@@ -5347,19 +5348,20 @@ declare class LiveUtils {
     /**
      * Saves strategy report to disk.
      *
+     * @param symbol - Trading pair symbol
      * @param strategyName - Strategy name to save report for
      * @param path - Optional directory path to save report (default: "./dump/live")
      *
      * @example
      * ```typescript
      * // Save to default path: ./dump/live/my-strategy.md
-     * await Live.dump("my-strategy");
+     * await Live.dump("BTCUSDT", "my-strategy");
      *
      * // Save to custom path: ./custom/path/my-strategy.md
-     * await Live.dump("my-strategy", "./custom/path");
+     * await Live.dump("BTCUSDT", "my-strategy", "./custom/path");
      * ```
      */
-    dump: (strategyName: StrategyName, path?: string) => Promise<void>;
+    dump: (symbol: string, strategyName: StrategyName, path?: string) => Promise<void>;
 }
 /**
  * Singleton instance of LiveUtils for convenient live trading operations.
@@ -5435,19 +5437,20 @@ declare class ScheduleUtils {
     /**
      * Saves strategy report to disk.
      *
+     * @param symbol - Trading pair symbol
      * @param strategyName - Strategy name to save report for
      * @param path - Optional directory path to save report (default: "./dump/schedule")
      *
      * @example
      * ```typescript
      * // Save to default path: ./dump/schedule/my-strategy.md
-     * await Schedule.dump("my-strategy");
+     * await Schedule.dump("BTCUSDT", "my-strategy");
      *
      * // Save to custom path: ./custom/path/my-strategy.md
-     * await Schedule.dump("my-strategy", "./custom/path");
+     * await Schedule.dump("BTCUSDT", "my-strategy", "./custom/path");
      * ```
      */
-    dump: (strategyName: StrategyName, path?: string) => Promise<void>;
+    dump: (symbol: string, strategyName: StrategyName, path?: string) => Promise<void>;
 }
 /**
  * Singleton instance of ScheduleUtils for convenient scheduled signals reporting.
@@ -5553,19 +5556,20 @@ declare class Performance {
      * Creates directory if it doesn't exist.
      * Default path: ./dump/performance/{strategyName}.md
      *
+     * @param symbol - Trading pair symbol
      * @param strategyName - Strategy name to save report for
      * @param path - Optional custom directory path
      *
      * @example
      * ```typescript
      * // Save to default path: ./dump/performance/my-strategy.md
-     * await Performance.dump("my-strategy");
+     * await Performance.dump("BTCUSDT", "my-strategy");
      *
      * // Save to custom path: ./reports/perf/my-strategy.md
-     * await Performance.dump("my-strategy", "./reports/perf");
+     * await Performance.dump("BTCUSDT", "my-strategy", "./reports/perf");
      * ```
      */
-    static dump(strategyName: string, path?: string): Promise<void>;
+    static dump(symbol: string, strategyName: string, path?: string): Promise<void>;
 }
 
 /**