@backtest-kit/pinets 3.0.0 → 3.0.2

package/README.md

@@ -1,3 +1,5 @@
+<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.

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,
@@ -756,13 +716,24 @@ 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);
+}
+
+const TO_MARKDOWN_METHOD_NAME = "markdown.toMarkdown";
+async function toMarkdown(signalId, plots, mapping) {
+    pine.loggerService.log(TO_MARKDOWN_METHOD_NAME, {
+        signalId,
+        plotCount: Object.keys(plots).length,
+        mapping,
+    });
+    return await pine.pineMarkdownService.getReport(signalId, plots, mapping);
 }
 
 exports.AXIS_SYMBOL = AXIS_SYMBOL;
@@ -774,5 +745,6 @@ exports.getSignal = getSignal;
 exports.lib = pine;
 exports.run = run;
 exports.setLogger = setLogger;
+exports.toMarkdown = toMarkdown;
 exports.toSignalDto = toSignalDto;
 exports.usePine = usePine;

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,
@@ -753,13 +713,24 @@ 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);
+}
+
+const TO_MARKDOWN_METHOD_NAME = "markdown.toMarkdown";
+async function toMarkdown(signalId, plots, mapping) {
+    pine.loggerService.log(TO_MARKDOWN_METHOD_NAME, {
+        signalId,
+        plotCount: Object.keys(plots).length,
+        mapping,
+    });
+    return await pine.pineMarkdownService.getReport(signalId, plots, mapping);
 }
 
-export { AXIS_SYMBOL, Code, File, dumpPlotData, extract, getSignal, pine as lib, run, setLogger, toSignalDto, usePine };
+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.0",
+  "version": "3.0.2",
   "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

@@ -83,8 +83,11 @@ interface IParams {
 }
 declare function getSignal(source: File | Code, { symbol, timeframe, limit }: IParams): Promise<ISignalDto | null>;
 
+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 dumpPlotData(signalId: ResultId$2, plots: PlotModel, taName: string, outputDir?: string): Promise<void>;
+declare function toMarkdown<M extends PlotMapping>(signalId: ResultId$2, plots: PlotModel, mapping: M): Promise<string>;
 
 type ResultId$1 = string | number;
 interface SignalData {
@@ -169,9 +172,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: {
@@ -185,4 +188,4 @@ declare const pine: {
     loggerService: LoggerService;
 };
 
-export { AXIS_SYMBOL, type CandleModel, Code, File, type ILogger, type IPine, type IProvider, type PlotExtractConfig, type PlotMapping, type PlotModel, type PlotRecord, type SymbolInfoModel, type TPineCtor, dumpPlotData, extract, getSignal, pine as lib, run, setLogger, toSignalDto, usePine };
+export { AXIS_SYMBOL, type CandleModel, Code, File, type ILogger, type IPine, type IProvider, type PlotExtractConfig, type PlotMapping, type PlotModel, type PlotRecord, type SymbolInfoModel, type TPineCtor, dumpPlotData, extract, getSignal, pine as lib, run, setLogger, toMarkdown, toSignalDto, usePine };