@backtest-kit/pinets 3.0.1 → 3.0.3

package/build/index.cjs

@@ -3,6 +3,7 @@
 var path = require('path');
 var backtestKit = require('backtest-kit');
 var diKit = require('di-kit');
+var diScoped = require('di-scoped');
 var functoolsKit = require('functools-kit');
 var fs = require('fs/promises');
 var module$1 = require('module');
@@ -82,6 +83,7 @@ const { provide, inject, init, override } = diKit.createActivator("pine");
 
 const baseServices = {
     loggerService: Symbol("loggerService"),
+    contextService: Symbol("contextService"),
 };
 const providerServices$1 = {
     axisProviderService: Symbol("axisProviderService"),
@@ -230,9 +232,28 @@ class AxisProviderService {
     }
 }
 
+const ContextService = diScoped.scoped(class {
+    constructor(context) {
+        this.context = context;
+    }
+});
+
+const GET_RAW_CANDLES_FN = async (self, symbol, interval, limit, sDate, eDate) => {
+    if (ContextService.hasContext()) {
+        return await backtestKit.Exchange.getRawCandles(symbol, interval, self.contextService.context, limit, sDate, eDate);
+    }
+    if (!backtestKit.MethodContextService.hasContext()) {
+        throw new Error("MethodContextService context is required to get market data for pinets if exchangeName?: string is not specified");
+    }
+    if (!backtestKit.ExecutionContextService.hasContext()) {
+        throw new Error("ExecutionContextService context is required to get market data for pinets if exchangeName?: string is not specified");
+    }
+    return await backtestKit.getRawCandles(symbol, interval, limit, sDate, eDate);
+};
 class CandleProviderService {
     constructor() {
         this.loggerService = inject(TYPES.loggerService);
+        this.contextService = inject(TYPES.contextService);
     }
     async getMarketData(tickerId, timeframe, limit, sDate, eDate) {
         this.loggerService.log("candleProviderService getMarketData", {
@@ -245,7 +266,7 @@ class CandleProviderService {
         const symbol = tickerId
             .toUpperCase()
             .replace(/^BINANCE:|^BYBIT:|^OKX:/, "");
-        const rawCandles = await backtestKit.getRawCandles(symbol, timeframe, limit, sDate, eDate);
+        const rawCandles = await GET_RAW_CANDLES_FN(this, symbol, timeframe, limit, sDate, eDate);
         const candles = rawCandles.map((c) => ({
             openTime: c.timestamp,
             open: c.open,
@@ -553,6 +574,7 @@ class PineMarkdownService {
 
 {
     provide(TYPES.loggerService, () => new LoggerService());
+    provide(TYPES.contextService, () => new ContextService());
 }
 {
     provide(TYPES.axisProviderService, () => new AxisProviderService());
@@ -576,6 +598,7 @@ class PineMarkdownService {
 
 const commonServices = {
     loggerService: inject(TYPES.loggerService),
+    contextService: inject(TYPES.contextService),
 };
 const providerServices = {
     axisProviderService: inject(TYPES.axisProviderService),
@@ -626,7 +649,13 @@ const GET_SOURCE_FN$1 = async (source) => {
     }
     throw new Error("Source must be a File or Code instance");
 };
-async function run(source, { symbol, timeframe, limit }) {
+const RUN_INFERENCE_FN = async (script, symbol, timeframe, limit, exchangeName) => {
+    if (exchangeName) {
+        return await ContextService.runInContext(async () => await pine.pineJobService.run(script, symbol, timeframe, limit), { exchangeName });
+    }
+    return await pine.pineJobService.run(script, symbol, timeframe, limit);
+};
+async function run(source, { symbol, timeframe, limit }, exchangeName) {
     pine.loggerService.info(METHOD_NAME_RUN$2, {
         source,
         symbol,
@@ -634,7 +663,7 @@ async function run(source, { symbol, timeframe, limit }) {
         limit,
     });
     const script = await GET_SOURCE_FN$1(source);
-    const { plots } = await pine.pineJobService.run(script, symbol, timeframe, limit);
+    const { plots } = await RUN_INFERENCE_FN(script, symbol, timeframe, limit, exchangeName);
     return plots;
 }
 
@@ -726,6 +755,16 @@ async function dumpPlotData(signalId, plots, mapping, taName, outputDir = "./dum
     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;
 exports.Code = Code;
 exports.File = File;
@@ -735,5 +774,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

@@ -1,6 +1,7 @@
 import { join } from 'path';
-import { getDate, getRawCandles, Markdown, MethodContextService, lib, ExecutionContextService } from 'backtest-kit';
+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 fs from 'fs/promises';
 import { createRequire } from 'module';
@@ -79,6 +80,7 @@ const { provide, inject, init, override } = createActivator("pine");
 
 const baseServices = {
     loggerService: Symbol("loggerService"),
+    contextService: Symbol("contextService"),
 };
 const providerServices$1 = {
     axisProviderService: Symbol("axisProviderService"),
@@ -227,9 +229,28 @@ class AxisProviderService {
     }
 }
 
+const ContextService = scoped(class {
+    constructor(context) {
+        this.context = context;
+    }
+});
+
+const GET_RAW_CANDLES_FN = async (self, symbol, interval, limit, sDate, eDate) => {
+    if (ContextService.hasContext()) {
+        return await Exchange.getRawCandles(symbol, interval, self.contextService.context, limit, sDate, eDate);
+    }
+    if (!MethodContextService.hasContext()) {
+        throw new Error("MethodContextService context is required to get market data for pinets if exchangeName?: string is not specified");
+    }
+    if (!ExecutionContextService.hasContext()) {
+        throw new Error("ExecutionContextService context is required to get market data for pinets if exchangeName?: string is not specified");
+    }
+    return await getRawCandles(symbol, interval, limit, sDate, eDate);
+};
 class CandleProviderService {
     constructor() {
         this.loggerService = inject(TYPES.loggerService);
+        this.contextService = inject(TYPES.contextService);
     }
     async getMarketData(tickerId, timeframe, limit, sDate, eDate) {
         this.loggerService.log("candleProviderService getMarketData", {
@@ -242,7 +263,7 @@ class CandleProviderService {
         const symbol = tickerId
             .toUpperCase()
             .replace(/^BINANCE:|^BYBIT:|^OKX:/, "");
-        const rawCandles = await getRawCandles(symbol, timeframe, limit, sDate, eDate);
+        const rawCandles = await GET_RAW_CANDLES_FN(this, symbol, timeframe, limit, sDate, eDate);
         const candles = rawCandles.map((c) => ({
             openTime: c.timestamp,
             open: c.open,
@@ -550,6 +571,7 @@ class PineMarkdownService {
 
 {
     provide(TYPES.loggerService, () => new LoggerService());
+    provide(TYPES.contextService, () => new ContextService());
 }
 {
     provide(TYPES.axisProviderService, () => new AxisProviderService());
@@ -573,6 +595,7 @@ class PineMarkdownService {
 
 const commonServices = {
     loggerService: inject(TYPES.loggerService),
+    contextService: inject(TYPES.contextService),
 };
 const providerServices = {
     axisProviderService: inject(TYPES.axisProviderService),
@@ -623,7 +646,13 @@ const GET_SOURCE_FN$1 = async (source) => {
     }
     throw new Error("Source must be a File or Code instance");
 };
-async function run(source, { symbol, timeframe, limit }) {
+const RUN_INFERENCE_FN = async (script, symbol, timeframe, limit, exchangeName) => {
+    if (exchangeName) {
+        return await ContextService.runInContext(async () => await pine.pineJobService.run(script, symbol, timeframe, limit), { exchangeName });
+    }
+    return await pine.pineJobService.run(script, symbol, timeframe, limit);
+};
+async function run(source, { symbol, timeframe, limit }, exchangeName) {
     pine.loggerService.info(METHOD_NAME_RUN$2, {
         source,
         symbol,
@@ -631,7 +660,7 @@ async function run(source, { symbol, timeframe, limit }) {
         limit,
     });
     const script = await GET_SOURCE_FN$1(source);
-    const { plots } = await pine.pineJobService.run(script, symbol, timeframe, limit);
+    const { plots } = await RUN_INFERENCE_FN(script, symbol, timeframe, limit, exchangeName);
     return plots;
 }
 
@@ -723,4 +752,14 @@ async function dumpPlotData(signalId, plots, mapping, taName, outputDir = "./dum
     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 };
+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, toMarkdown, toSignalDto, usePine };

package/package.json

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

@@ -42,12 +42,17 @@ interface IPine {
 
 declare function usePine<T = TPineCtor>(ctor: T): void;
 
+type ExchangeName = string;
+interface IContext {
+    exchangeName: ExchangeName;
+}
+
 interface IRunParams {
     symbol: string;
     timeframe: CandleInterval;
     limit: number;
 }
-declare function run(source: File | Code, { symbol, timeframe, limit }: IRunParams): Promise<PlotModel>;
+declare function run(source: File | Code, { symbol, timeframe, limit }: IRunParams, exchangeName?: ExchangeName): Promise<PlotModel>;
 
 type PlotExtractConfig<T = number> = {
     plot: string;
@@ -83,8 +88,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<M extends PlotMapping>(signalId: ResultId$2, plots: PlotModel, mapping: M, 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 {
@@ -135,7 +143,10 @@ declare class LoggerService implements ILogger {
 }
 
 declare class CandleProviderService implements IProvider {
-    private readonly loggerService;
+    readonly loggerService: LoggerService;
+    readonly contextService: {
+        readonly context: IContext;
+    };
     getMarketData(tickerId: string, timeframe: string, limit?: number, sDate?: number, eDate?: number): Promise<any[]>;
     getSymbolInfo(tickerId: string): Promise<any>;
 }
@@ -183,6 +194,9 @@ declare const pine: {
     axisProviderService: AxisProviderService;
     candleProviderService: CandleProviderService;
     loggerService: LoggerService;
+    contextService: {
+        readonly context: IContext;
+    };
 };
 
-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 };