@backtest-kit/pinets 0.0.6 → 3.0.1

package/README.md

@@ -1,8 +1,10 @@
+<img src="https://github.com/tripolskypetr/backtest-kit/raw/refs/heads/master/assets/heraldry.svg" height="45px" align="right">
+
 # 📜 @backtest-kit/pinets
 
 > Run TradingView Pine Script strategies in Node.js self hosted enviroment. Execute your existing Pine Script indicators and generate trading signals - pure technical analysis with 1:1 syntax compatibility.
 
-![bots](https://raw.githubusercontent.com/tripolskypetr/backtest-kit/HEAD/assets/bots.png)
+![screenshot](https://raw.githubusercontent.com/tripolskypetr/backtest-kit/HEAD/assets/screenshots/screenshot8.png)
 
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tripolskypetr/backtest-kit)
 [![npm](https://img.shields.io/npm/v/@backtest-kit/pinets.svg?style=flat-square)](https://npmjs.org/package/@backtest-kit/pinets)
@@ -29,7 +31,11 @@ Port your TradingView strategies to backtest-kit with zero rewrite. Powered by [
 | Function | Description |
 |----------|-------------|
 | **`getSignal()`** | Run Pine Script and get structured `ISignalDto` (position, TP/SL, estimated time) |
-| **`run()`** | Run Pine Script with custom plot mapping for advanced extraction |
+| **`run()`** | Run Pine Script and return raw plot data |
+| **`extract()`** | Extract values from plots with custom mapping |
+| **`dumpPlotData()`** | Dump plot data to markdown files for debugging |
+| **`usePine()`** | Register custom Pine constructor |
+| **`setLogger()`** | Configure custom logger |
 | **`File.fromPath()`** | Load Pine Script from `.pine` file |
 | **`Code.fromString()`** | Use inline Pine Script code |
 
@@ -141,7 +147,7 @@ const plots = await run(source, {
   limit: 200,
 });
 
-const data = extract(plots, {
+const data = await extract(plots, {
   // Simple: plot name -> number
   rsi: 'RSI',
   macd: 'MACD',
@@ -160,6 +166,51 @@ const data = extract(plots, {
 // data = { rsi: 55.2, macd: 12.5, prevRsi: 52.1, trendStrength: 'strong' }
 ```
 
+### Debug with Plot Dump
+
+Dump plot data to markdown files for analysis and debugging:
+
+```typescript
+import { File, run, dumpPlotData } from '@backtest-kit/pinets';
+
+const source = File.fromPath('strategy.pine');
+
+const plots = await run(source, {
+  symbol: 'BTCUSDT',
+  timeframe: '1h',
+  limit: 100,
+});
+
+// Dump plots to ./dump/ta directory
+await dumpPlotData('signal-001', plots, 'ema-cross', './dump/ta');
+```
+
+### Custom Pine Constructor
+
+Register a custom Pine constructor for advanced configurations:
+
+```typescript
+import { usePine } from '@backtest-kit/pinets';
+import { Pine } from 'pinets';
+
+// Use custom Pine instance
+usePine(Pine);
+```
+
+### Custom Logger
+
+Configure logging for debugging:
+
+```typescript
+import { setLogger } from '@backtest-kit/pinets';
+
+setLogger({
+  log: (method, data) => console.log(`[${method}]`, data),
+  info: (method, data) => console.info(`[${method}]`, data),
+  error: (method, data) => console.error(`[${method}]`, data),
+});
+```
+
 ## 📜 Pine Script Conventions
 
 For `getSignal()` to work, your Pine Script must include these plots:

package/build/index.cjs

@@ -463,120 +463,80 @@ const GET_EXECUTION_CONTEXT_FN = () => {
         when: "",
     };
 };
-const DEFAULT_FORMAT = (v) => v !== null ? Number(v).toFixed(4) : "N/A";
-function isUnsafe(value) {
-    if (value === null)
-        return true;
-    if (typeof value !== "number")
-        return true;
-    if (isNaN(value))
-        return true;
-    if (!isFinite(value))
-        return true;
-    return false;
+function getPlotName(config) {
+    return typeof config === "string" ? config : config.plot;
 }
-function extractRowAtIndex(plots, keys, index) {
-    let time = null;
-    for (const key of keys) {
-        const plotData = plots[key]?.data;
-        if (plotData && plotData[index]) {
-            time = plotData[index].time;
-            break;
-        }
-    }
-    if (time === null)
-        return null;
-    const row = { time };
-    for (const key of keys) {
-        const plotData = plots[key]?.data;
-        if (plotData && plotData[index]) {
-            const value = plotData[index].value;
-            row[key] = isUnsafe(value) ? null : value;
-        }
-        else {
-            row[key] = null;
-        }
-    }
-    return row;
-}
-function isRowWarmedUp(row, keys) {
-    for (const key of keys) {
-        if (isUnsafe(row[key])) {
-            return false;
-        }
-    }
-    return true;
+function isSafe(value) {
+    return typeof value === "number" && !isNaN(value) && isFinite(value);
 }
+const DEFAULT_FORMAT = (v) => v !== null ? Number(v).toFixed(4) : "N/A";
 function generateMarkdownTable(rows, keys, signalId) {
-    let markdown = "";
     const { when: createdAt } = GET_EXECUTION_CONTEXT_FN();
-    markdown += `# PineScript Technical Analysis Dump\n\n`;
+    let markdown = `# PineScript Technical Analysis Dump\n\n`;
     markdown += `**Signal ID**: ${String(signalId)}\n`;
     if (createdAt) {
         markdown += `**Current datetime**: ${String(createdAt)}\n`;
     }
     markdown += "\n";
-    const header = `| Timestamp | ${keys.join(" | ")} |\n`;
-    const separator = `| --- | ${keys.map(() => "---").join(" | ")} |\n`;
-    markdown += header;
-    markdown += separator;
+    markdown += `| ${keys.join(" | ")} | timestamp |\n`;
+    markdown += `| --- | ${keys.map(() => "---").join(" | ")} |\n`;
     for (const row of rows) {
         const timestamp = new Date(row.time).toISOString();
         const cells = keys.map((key) => DEFAULT_FORMAT(row[key]));
-        markdown += `| ${timestamp} | ${cells.join(" | ")} |\n`;
+        markdown += `| ${cells.join(" | ")} | ${timestamp} |\n`;
     }
     return markdown;
 }
 class PineMarkdownService {
     constructor() {
         this.loggerService = inject(TYPES.loggerService);
-        this.getData = (plots) => {
-            this.loggerService.log("pineMarkdownService getReport", {
+        this.getData = (plots, mapping) => {
+            this.loggerService.log("pineMarkdownService getData", {
                 plotCount: Object.keys(plots).length,
             });
-            const keys = Object.keys(plots);
-            if (keys.length === 0) {
+            const entries = Object.entries(mapping);
+            if (entries.length === 0) {
                 return [];
             }
-            const firstPlot = plots[keys[0]];
-            const dataLength = firstPlot?.data?.length ?? 0;
+            const plotNames = entries.map(([key, config]) => ({ key, plotName: getPlotName(config) }));
+            const dataLength = Math.max(...plotNames.map(({ plotName }) => plots[plotName]?.data?.length ?? 0));
             if (dataLength === 0) {
                 return [];
             }
             const rows = [];
-            let warmupComplete = false;
             for (let i = 0; i < dataLength; i++) {
-                const row = extractRowAtIndex(plots, keys, i);
-                if (!row)
-                    continue;
-                if (!warmupComplete) {
-                    if (isRowWarmedUp(row, keys)) {
-                        warmupComplete = true;
-                    }
-                    else {
-                        continue;
+                let time = null;
+                const row = { time: 0 };
+                for (const { key, plotName } of plotNames) {
+                    const point = plots[plotName]?.data?.[i];
+                    if (time === null && point) {
+                        time = point.time;
                     }
+                    row[key] = isSafe(point?.value) ? point.value : null;
+                }
+                if (time !== null) {
+                    row.time = time;
+                    rows.push(row);
                 }
-                rows.push(row);
             }
             return rows.slice(-TABLE_ROWS_LIMIT);
         };
-        this.getReport = (signalId, plots) => {
+        this.getReport = (signalId, plots, mapping) => {
             this.loggerService.log("pineMarkdownService getReport", {
                 signalId,
                 plotCount: Object.keys(plots).length,
             });
-            const rows = this.getData(plots);
-            const keys = Object.keys(plots);
+            const keys = Object.keys(mapping);
+            const rows = this.getData(plots, mapping);
             return generateMarkdownTable(rows, keys, signalId);
         };
-        this.dump = async (signalId, plots, taName, outputDir = `./dump/ta/${taName}`) => {
+        this.dump = async (signalId, plots, mapping, taName, outputDir = `./dump/ta/${taName}`) => {
             this.loggerService.log("pineMarkdownService dumpSignal", {
                 signalId,
                 plotCount: Object.keys(plots).length,
                 outputDir,
             });
-            const content = this.getReport(signalId, plots);
+            const content = this.getReport(signalId, plots, mapping);
             const { exchangeName, frameName, strategyName } = GET_METHOD_CONTEXT_FN();
             await backtestKit.Markdown.writeData(taName, content, {
                 path: outputDir,
@@ -690,26 +650,32 @@ function setLogger(logger) {
     pine.loggerService.setLogger(logger);
 }
 
-function toSignalDto(id, data) {
+function toSignalDto(id, data, priceOpen = data.priceOpen) {
     if (data.position === 1) {
-        return {
+        const result = {
             id: String(id),
             position: "long",
-            priceOpen: data.priceOpen,
             priceTakeProfit: data.priceTakeProfit,
             priceStopLoss: data.priceStopLoss,
             minuteEstimatedTime: data.minuteEstimatedTime,
         };
+        if (priceOpen) {
+            Object.assign(result, { priceOpen });
+        }
+        return result;
     }
     if (data.position === -1) {
-        return {
+        const result = {
             id: String(id),
             position: "short",
-            priceOpen: data.priceOpen,
             priceTakeProfit: data.priceTakeProfit,
             priceStopLoss: data.priceStopLoss,
             minuteEstimatedTime: data.minuteEstimatedTime,
         };
+        if (priceOpen) {
+            Object.assign(result, { priceOpen });
+        }
+        return result;
     }
     return null;
 }
@@ -750,13 +716,14 @@ async function getSignal(source, { symbol, timeframe, limit }) {
 }
 
 const DUMP_SIGNAL_METHOD_NAME = "dump.dumpSignal";
-async function dumpPlotData(signalId, plots, taName, outputDir = "./dump/ta") {
+async function dumpPlotData(signalId, plots, mapping, taName, outputDir = "./dump/ta") {
     pine.loggerService.log(DUMP_SIGNAL_METHOD_NAME, {
         signalId,
         plotCount: Object.keys(plots).length,
+        mapping,
         outputDir,
     });
-    return await pine.pineMarkdownService.dump(signalId, plots, taName, outputDir);
+    return await pine.pineMarkdownService.dump(signalId, plots, mapping, taName, outputDir);
 }
 
 exports.AXIS_SYMBOL = AXIS_SYMBOL;

package/build/index.mjs

@@ -460,120 +460,80 @@ const GET_EXECUTION_CONTEXT_FN = () => {
         when: "",
     };
 };
-const DEFAULT_FORMAT = (v) => v !== null ? Number(v).toFixed(4) : "N/A";
-function isUnsafe(value) {
-    if (value === null)
-        return true;
-    if (typeof value !== "number")
-        return true;
-    if (isNaN(value))
-        return true;
-    if (!isFinite(value))
-        return true;
-    return false;
+function getPlotName(config) {
+    return typeof config === "string" ? config : config.plot;
 }
-function extractRowAtIndex(plots, keys, index) {
-    let time = null;
-    for (const key of keys) {
-        const plotData = plots[key]?.data;
-        if (plotData && plotData[index]) {
-            time = plotData[index].time;
-            break;
-        }
-    }
-    if (time === null)
-        return null;
-    const row = { time };
-    for (const key of keys) {
-        const plotData = plots[key]?.data;
-        if (plotData && plotData[index]) {
-            const value = plotData[index].value;
-            row[key] = isUnsafe(value) ? null : value;
-        }
-        else {
-            row[key] = null;
-        }
-    }
-    return row;
-}
-function isRowWarmedUp(row, keys) {
-    for (const key of keys) {
-        if (isUnsafe(row[key])) {
-            return false;
-        }
-    }
-    return true;
+function isSafe(value) {
+    return typeof value === "number" && !isNaN(value) && isFinite(value);
 }
+const DEFAULT_FORMAT = (v) => v !== null ? Number(v).toFixed(4) : "N/A";
 function generateMarkdownTable(rows, keys, signalId) {
-    let markdown = "";
     const { when: createdAt } = GET_EXECUTION_CONTEXT_FN();
-    markdown += `# PineScript Technical Analysis Dump\n\n`;
+    let markdown = `# PineScript Technical Analysis Dump\n\n`;
     markdown += `**Signal ID**: ${String(signalId)}\n`;
     if (createdAt) {
         markdown += `**Current datetime**: ${String(createdAt)}\n`;
     }
     markdown += "\n";
-    const header = `| Timestamp | ${keys.join(" | ")} |\n`;
-    const separator = `| --- | ${keys.map(() => "---").join(" | ")} |\n`;
-    markdown += header;
-    markdown += separator;
+    markdown += `| ${keys.join(" | ")} | timestamp |\n`;
+    markdown += `| --- | ${keys.map(() => "---").join(" | ")} |\n`;
     for (const row of rows) {
         const timestamp = new Date(row.time).toISOString();
         const cells = keys.map((key) => DEFAULT_FORMAT(row[key]));
-        markdown += `| ${timestamp} | ${cells.join(" | ")} |\n`;
+        markdown += `| ${cells.join(" | ")} | ${timestamp} |\n`;
     }
     return markdown;
 }
 class PineMarkdownService {
     constructor() {
         this.loggerService = inject(TYPES.loggerService);
-        this.getData = (plots) => {
-            this.loggerService.log("pineMarkdownService getReport", {
+        this.getData = (plots, mapping) => {
+            this.loggerService.log("pineMarkdownService getData", {
                 plotCount: Object.keys(plots).length,
             });
-            const keys = Object.keys(plots);
-            if (keys.length === 0) {
+            const entries = Object.entries(mapping);
+            if (entries.length === 0) {
                 return [];
             }
-            const firstPlot = plots[keys[0]];
-            const dataLength = firstPlot?.data?.length ?? 0;
+            const plotNames = entries.map(([key, config]) => ({ key, plotName: getPlotName(config) }));
+            const dataLength = Math.max(...plotNames.map(({ plotName }) => plots[plotName]?.data?.length ?? 0));
             if (dataLength === 0) {
                 return [];
             }
             const rows = [];
-            let warmupComplete = false;
             for (let i = 0; i < dataLength; i++) {
-                const row = extractRowAtIndex(plots, keys, i);
-                if (!row)
-                    continue;
-                if (!warmupComplete) {
-                    if (isRowWarmedUp(row, keys)) {
-                        warmupComplete = true;
-                    }
-                    else {
-                        continue;
+                let time = null;
+                const row = { time: 0 };
+                for (const { key, plotName } of plotNames) {
+                    const point = plots[plotName]?.data?.[i];
+                    if (time === null && point) {
+                        time = point.time;
                     }
+                    row[key] = isSafe(point?.value) ? point.value : null;
+                }
+                if (time !== null) {
+                    row.time = time;
+                    rows.push(row);
                 }
-                rows.push(row);
             }
             return rows.slice(-TABLE_ROWS_LIMIT);
         };
-        this.getReport = (signalId, plots) => {
+        this.getReport = (signalId, plots, mapping) => {
             this.loggerService.log("pineMarkdownService getReport", {
                 signalId,
                 plotCount: Object.keys(plots).length,
             });
-            const rows = this.getData(plots);
-            const keys = Object.keys(plots);
+            const keys = Object.keys(mapping);
+            const rows = this.getData(plots, mapping);
             return generateMarkdownTable(rows, keys, signalId);
         };
-        this.dump = async (signalId, plots, taName, outputDir = `./dump/ta/${taName}`) => {
+        this.dump = async (signalId, plots, mapping, taName, outputDir = `./dump/ta/${taName}`) => {
             this.loggerService.log("pineMarkdownService dumpSignal", {
                 signalId,
                 plotCount: Object.keys(plots).length,
                 outputDir,
             });
-            const content = this.getReport(signalId, plots);
+            const content = this.getReport(signalId, plots, mapping);
             const { exchangeName, frameName, strategyName } = GET_METHOD_CONTEXT_FN();
             await Markdown.writeData(taName, content, {
                 path: outputDir,
@@ -687,26 +647,32 @@ function setLogger(logger) {
     pine.loggerService.setLogger(logger);
 }
 
-function toSignalDto(id, data) {
+function toSignalDto(id, data, priceOpen = data.priceOpen) {
     if (data.position === 1) {
-        return {
+        const result = {
             id: String(id),
             position: "long",
-            priceOpen: data.priceOpen,
             priceTakeProfit: data.priceTakeProfit,
             priceStopLoss: data.priceStopLoss,
             minuteEstimatedTime: data.minuteEstimatedTime,
         };
+        if (priceOpen) {
+            Object.assign(result, { priceOpen });
+        }
+        return result;
     }
     if (data.position === -1) {
-        return {
+        const result = {
             id: String(id),
             position: "short",
-            priceOpen: data.priceOpen,
             priceTakeProfit: data.priceTakeProfit,
             priceStopLoss: data.priceStopLoss,
             minuteEstimatedTime: data.minuteEstimatedTime,
         };
+        if (priceOpen) {
+            Object.assign(result, { priceOpen });
+        }
+        return result;
     }
     return null;
 }
@@ -747,13 +713,14 @@ async function getSignal(source, { symbol, timeframe, limit }) {
 }
 
 const DUMP_SIGNAL_METHOD_NAME = "dump.dumpSignal";
-async function dumpPlotData(signalId, plots, taName, outputDir = "./dump/ta") {
+async function dumpPlotData(signalId, plots, mapping, taName, outputDir = "./dump/ta") {
     pine.loggerService.log(DUMP_SIGNAL_METHOD_NAME, {
         signalId,
         plotCount: Object.keys(plots).length,
+        mapping,
         outputDir,
     });
-    return await pine.pineMarkdownService.dump(signalId, plots, taName, outputDir);
+    return await pine.pineMarkdownService.dump(signalId, plots, mapping, taName, outputDir);
 }
 
 export { AXIS_SYMBOL, Code, File, dumpPlotData, extract, getSignal, pine as lib, run, setLogger, toSignalDto, usePine };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backtest-kit/pinets",
-  "version": "0.0.6",
+  "version": "3.0.1",
   "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",
@@ -72,8 +72,8 @@
     "worker-testbed": "1.0.12"
   },
   "peerDependencies": {
-    "backtest-kit": "^2.2.1",
-    "pinets": "^0.8.3",
+    "backtest-kit": "^3.0.5",
+    "pinets": "^0.8.6",
     "typescript": "^5.0.0"
   },
   "dependencies": {

package/types.d.ts

@@ -84,12 +84,12 @@ interface IParams {
 declare function getSignal(source: File | Code, { symbol, timeframe, limit }: IParams): Promise<ISignalDto | null>;
 
 type ResultId$2 = string | number;
-declare function dumpPlotData(signalId: ResultId$2, plots: PlotModel, taName: string, outputDir?: string): Promise<void>;
+declare function dumpPlotData<M extends PlotMapping>(signalId: ResultId$2, plots: PlotModel, mapping: M, taName: string, outputDir?: string): Promise<void>;
 
 type ResultId$1 = string | number;
 interface SignalData {
     position: number;
-    priceOpen: number;
+    priceOpen?: number;
     priceTakeProfit: number;
     priceStopLoss: number;
     minuteEstimatedTime: number;
@@ -97,7 +97,7 @@ interface SignalData {
 interface Signal extends ISignalDto {
     id: string;
 }
-declare function toSignalDto(id: ResultId$1, data: SignalData): Signal | null;
+declare function toSignalDto(id: ResultId$1, data: SignalData, priceOpen?: number | null | undefined): Signal | null;
 
 interface CandleModel {
     openTime: number;
@@ -169,9 +169,9 @@ interface IPlotRow {
 }
 declare class PineMarkdownService {
     private readonly loggerService;
-    getData: (plots: PlotModel) => IPlotRow[];
-    getReport: (signalId: ResultId, plots: PlotModel) => string;
-    dump: (signalId: ResultId, plots: PlotModel, taName: string, outputDir?: string) => Promise<void>;
+    getData: <M extends PlotMapping>(plots: PlotModel, mapping: M) => IPlotRow[];
+    getReport: <M extends PlotMapping>(signalId: ResultId, plots: PlotModel, mapping: M) => string;
+    dump: <M extends PlotMapping>(signalId: ResultId, plots: PlotModel, mapping: M, taName: string, outputDir?: string) => Promise<void>;
 }
 
 declare const pine: {