@backtest-kit/pinets 3.0.5 → 3.0.7

package/build/index.cjs

@@ -514,7 +514,7 @@ function generateMarkdownTable(rows, keys, signalId) {
 class PineMarkdownService {
     constructor() {
         this.loggerService = inject(TYPES.loggerService);
-        this.getData = (plots, mapping) => {
+        this.getData = (plots, mapping, limit = TABLE_ROWS_LIMIT) => {
             this.loggerService.log("pineMarkdownService getData", {
                 plotCount: Object.keys(plots).length,
             });
@@ -543,15 +543,15 @@ class PineMarkdownService {
                     rows.push(row);
                 }
             }
-            return rows.slice(-TABLE_ROWS_LIMIT);
+            return rows.slice(-limit);
         };
-        this.getReport = (signalId, plots, mapping) => {
+        this.getReport = (signalId, plots, mapping, limit = TABLE_ROWS_LIMIT) => {
             this.loggerService.log("pineMarkdownService getReport", {
                 signalId,
                 plotCount: Object.keys(plots).length,
             });
             const keys = Object.keys(mapping);
-            const rows = this.getData(plots, mapping);
+            const rows = this.getData(plots, mapping, limit);
             return generateMarkdownTable(rows, keys, signalId);
         };
         this.dump = async (signalId, plots, mapping, taName, outputDir = `./dump/ta/${taName}`) => {
@@ -658,6 +658,11 @@ const GET_SOURCE_FN$1 = async (source) => {
     throw new Error("Source must be a File or Code instance");
 };
 const BASE_RUNNER_FN = async (script, symbol, timeframe, limit) => await pine.pineJobService.run(script, symbol, timeframe, limit);
+const VALIDATE_NO_TRADING_FN = async () => {
+    if (backtestKit.ExecutionContextService.hasContext()) {
+        throw new Error(functoolsKit.str.newline("Time overrides are not allowed when running scripts in a trading context.", "Please remove the 'when' parameter from the run function call."));
+    }
+};
 const CREATE_INFERENCE_FN = (script, symbol, timeframe, limit, exchangeName, when) => {
     let fn = () => BASE_RUNNER_FN(script, symbol, timeframe, limit);
     if (exchangeName) {
@@ -673,6 +678,9 @@ const CREATE_INFERENCE_FN = (script, symbol, timeframe, limit, exchangeName, whe
     return fn;
 };
 const RUN_INFERENCE_FN = async (script, symbol, timeframe, limit, exchangeName, when) => {
+    if (when) {
+        VALIDATE_NO_TRADING_FN();
+    }
     const inference = CREATE_INFERENCE_FN(script, symbol, timeframe, limit, exchangeName, when);
     return await inference();
 };
@@ -777,13 +785,14 @@ async function dumpPlotData(signalId, plots, mapping, taName, outputDir = "./dum
 }
 
 const TO_MARKDOWN_METHOD_NAME = "markdown.toMarkdown";
-async function toMarkdown(signalId, plots, mapping) {
+async function toMarkdown(signalId, plots, mapping, limit = Number.POSITIVE_INFINITY) {
     pine.loggerService.log(TO_MARKDOWN_METHOD_NAME, {
         signalId,
         plotCount: Object.keys(plots).length,
         mapping,
+        limit,
     });
-    return await pine.pineMarkdownService.getReport(signalId, plots, mapping);
+    return await pine.pineMarkdownService.getReport(signalId, plots, mapping, limit);
 }
 
 exports.AXIS_SYMBOL = AXIS_SYMBOL;

package/build/index.mjs

@@ -2,7 +2,7 @@ import { join } from 'path';
 import { getDate, Exchange, MethodContextService, ExecutionContextService, getRawCandles, Markdown, lib } from 'backtest-kit';
 import { createActivator } from 'di-kit';
 import { scoped } from 'di-scoped';
-import { singleshot, memoize, randomString } from 'functools-kit';
+import { singleshot, memoize, str, randomString } from 'functools-kit';
 import fs from 'fs/promises';
 import { createRequire } from 'module';
 
@@ -511,7 +511,7 @@ function generateMarkdownTable(rows, keys, signalId) {
 class PineMarkdownService {
     constructor() {
         this.loggerService = inject(TYPES.loggerService);
-        this.getData = (plots, mapping) => {
+        this.getData = (plots, mapping, limit = TABLE_ROWS_LIMIT) => {
             this.loggerService.log("pineMarkdownService getData", {
                 plotCount: Object.keys(plots).length,
             });
@@ -540,15 +540,15 @@ class PineMarkdownService {
                     rows.push(row);
                 }
             }
-            return rows.slice(-TABLE_ROWS_LIMIT);
+            return rows.slice(-limit);
         };
-        this.getReport = (signalId, plots, mapping) => {
+        this.getReport = (signalId, plots, mapping, limit = TABLE_ROWS_LIMIT) => {
             this.loggerService.log("pineMarkdownService getReport", {
                 signalId,
                 plotCount: Object.keys(plots).length,
             });
             const keys = Object.keys(mapping);
-            const rows = this.getData(plots, mapping);
+            const rows = this.getData(plots, mapping, limit);
             return generateMarkdownTable(rows, keys, signalId);
         };
         this.dump = async (signalId, plots, mapping, taName, outputDir = `./dump/ta/${taName}`) => {
@@ -655,6 +655,11 @@ const GET_SOURCE_FN$1 = async (source) => {
     throw new Error("Source must be a File or Code instance");
 };
 const BASE_RUNNER_FN = async (script, symbol, timeframe, limit) => await pine.pineJobService.run(script, symbol, timeframe, limit);
+const VALIDATE_NO_TRADING_FN = async () => {
+    if (ExecutionContextService.hasContext()) {
+        throw new Error(str.newline("Time overrides are not allowed when running scripts in a trading context.", "Please remove the 'when' parameter from the run function call."));
+    }
+};
 const CREATE_INFERENCE_FN = (script, symbol, timeframe, limit, exchangeName, when) => {
     let fn = () => BASE_RUNNER_FN(script, symbol, timeframe, limit);
     if (exchangeName) {
@@ -670,6 +675,9 @@ const CREATE_INFERENCE_FN = (script, symbol, timeframe, limit, exchangeName, whe
     return fn;
 };
 const RUN_INFERENCE_FN = async (script, symbol, timeframe, limit, exchangeName, when) => {
+    if (when) {
+        VALIDATE_NO_TRADING_FN();
+    }
     const inference = CREATE_INFERENCE_FN(script, symbol, timeframe, limit, exchangeName, when);
     return await inference();
 };
@@ -774,13 +782,14 @@ async function dumpPlotData(signalId, plots, mapping, taName, outputDir = "./dum
 }
 
 const TO_MARKDOWN_METHOD_NAME = "markdown.toMarkdown";
-async function toMarkdown(signalId, plots, mapping) {
+async function toMarkdown(signalId, plots, mapping, limit = Number.POSITIVE_INFINITY) {
     pine.loggerService.log(TO_MARKDOWN_METHOD_NAME, {
         signalId,
         plotCount: Object.keys(plots).length,
         mapping,
+        limit,
     });
-    return await pine.pineMarkdownService.getReport(signalId, plots, mapping);
+    return await pine.pineMarkdownService.getReport(signalId, plots, mapping, limit);
 }
 
 export { AXIS_SYMBOL, Code, File, dumpPlotData, extract, getSignal, pine as lib, run, setLogger, toMarkdown, toSignalDto, usePine };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backtest-kit/pinets",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "description": "Run TradingView Pine Script strategies in Node.js self hosted environment. Execute existing Pine Script indicators and generate trading signals with 1:1 syntax compatibility via PineTS runtime.",
   "author": {
     "name": "Petr Tripolsky",

package/types.d.ts

@@ -92,7 +92,7 @@ type ResultId$3 = string | number;
 declare function dumpPlotData<M extends PlotMapping>(signalId: ResultId$3, plots: PlotModel, mapping: M, taName: string, outputDir?: string): Promise<void>;
 
 type ResultId$2 = string | number;
-declare function toMarkdown<M extends PlotMapping>(signalId: ResultId$2, plots: PlotModel, mapping: M): Promise<string>;
+declare function toMarkdown<M extends PlotMapping>(signalId: ResultId$2, plots: PlotModel, mapping: M, limit?: number): Promise<string>;
 
 type ResultId$1 = string | number;
 interface SignalData {
@@ -180,8 +180,8 @@ interface IPlotRow {
 }
 declare class PineMarkdownService {
     private readonly loggerService;
-    getData: <M extends PlotMapping>(plots: PlotModel, mapping: M) => IPlotRow[];
-    getReport: <M extends PlotMapping>(signalId: ResultId, plots: PlotModel, mapping: M) => string;
+    getData: <M extends PlotMapping>(plots: PlotModel, mapping: M, limit?: number) => IPlotRow[];
+    getReport: <M extends PlotMapping>(signalId: ResultId, plots: PlotModel, mapping: M, limit?: number) => string;
     dump: <M extends PlotMapping>(signalId: ResultId, plots: PlotModel, mapping: M, taName: string, outputDir?: string) => Promise<void>;
 }