@backtest-kit/pinets 0.0.5 → 3.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 > 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 +29,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 +145,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 +164,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

@@ -690,26 +690,32 @@ function setLogger(logger) {
     pine.loggerService.setLogger(logger);
 }
 
-function toSignalDto(data) {
+function toSignalDto(id, data, priceOpen = data.priceOpen) {
     if (data.position === 1) {
-        return {
-            id: functoolsKit.randomString(),
+        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 {
-            id: functoolsKit.randomString(),
+        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;
 }
@@ -744,8 +750,9 @@ async function getSignal(source, { symbol, timeframe, limit }) {
         limit,
     });
     const { plots } = await pine.pineJobService.run(await GET_SOURCE_FN(source), symbol, timeframe, limit);
+    const resultId = functoolsKit.randomString();
     const data = pine.pineDataService.extract(plots, SIGNAL_SCHEMA);
-    return toSignalDto(data);
+    return toSignalDto(resultId, data);
 }
 
 const DUMP_SIGNAL_METHOD_NAME = "dump.dumpSignal";

package/build/index.mjs

@@ -687,26 +687,32 @@ function setLogger(logger) {
     pine.loggerService.setLogger(logger);
 }
 
-function toSignalDto(data) {
+function toSignalDto(id, data, priceOpen = data.priceOpen) {
     if (data.position === 1) {
-        return {
-            id: randomString(),
+        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 {
-            id: randomString(),
+        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;
 }
@@ -741,8 +747,9 @@ async function getSignal(source, { symbol, timeframe, limit }) {
         limit,
     });
     const { plots } = await pine.pineJobService.run(await GET_SOURCE_FN(source), symbol, timeframe, limit);
+    const resultId = randomString();
     const data = pine.pineDataService.extract(plots, SIGNAL_SCHEMA);
-    return toSignalDto(data);
+    return toSignalDto(resultId, data);
 }
 
 const DUMP_SIGNAL_METHOD_NAME = "dump.dumpSignal";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backtest-kit/pinets",
-  "version": "0.0.5",
+  "version": "3.0.0",
   "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

@@ -83,12 +83,13 @@ interface IParams {
 }
 declare function getSignal(source: File | Code, { symbol, timeframe, limit }: IParams): Promise<ISignalDto | null>;
 
-type ResultId$1 = string | number;
-declare function dumpPlotData(signalId: ResultId$1, plots: PlotModel, 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>;
 
+type ResultId$1 = string | number;
 interface SignalData {
     position: number;
-    priceOpen: number;
+    priceOpen?: number;
     priceTakeProfit: number;
     priceStopLoss: number;
     minuteEstimatedTime: number;
@@ -96,7 +97,7 @@ interface SignalData {
 interface Signal extends ISignalDto {
     id: string;
 }
-declare function toSignalDto(data: SignalData): Signal | null;
+declare function toSignalDto(id: ResultId$1, data: SignalData, priceOpen?: number | null | undefined): Signal | null;
 
 interface CandleModel {
     openTime: number;