@backtest-kit/cli 0.0.1

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@backtest-kit/cli",
+  "version": "0.0.1",
+  "description": "The CLI for launching backtests without a boilerplate",
+  "author": {
+    "name": "Petr Tripolsky",
+    "email": "tripolskypetr@gmail.com",
+    "url": "https://github.com/tripolskypetr"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "http://paypal.me/tripolskypetr"
+  },
+  "license": "MIT",
+  "homepage": "https://backtest-kit.github.io/documents/example_02_first_backtest.html",
+  "keywords": [],
+  "files": [
+    "build",
+    "types.d.ts",
+    "template",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tripolskypetr/backtest-kit",
+    "documentation": "https://github.com/tripolskypetr/backtest-kit/tree/master/docs"
+  },
+  "bugs": {
+    "url": "https://github.com/tripolskypetr/backtest-kit/issues"
+  },
+  "scripts": {
+    "build": "rollup -c"
+  },
+  "main": "build/index.cjs",
+  "module": "build/index.mjs",
+  "source": "src/index.ts",
+  "types": "./types.d.ts",
+  "exports": {
+    "require": "./build/index.cjs",
+    "types": "./types.d.ts",
+    "import": "./build/index.mjs",
+    "default": "./build/index.cjs"
+  },
+  "devDependencies": {
+    "@backtest-kit/ui": "3.1.0",
+    "@rollup/plugin-typescript": "11.1.6",
+    "@types/image-size": "0.7.0",
+    "@types/jsdom": "21.1.7",
+    "@types/mustache": "4.2.6",
+    "@types/node": "22.9.0",
+    "@types/stack-trace": "0.0.33",
+    "backtest-kit": "3.1.0",
+    "glob": "11.0.1",
+    "rimraf": "6.0.1",
+    "rollup": "3.29.5",
+    "rollup-plugin-dts": "6.1.1",
+    "rollup-plugin-peer-deps-external": "2.2.4",
+    "ts-morph": "27.0.2",
+    "tslib": "2.7.0",
+    "typedoc": "0.27.9",
+    "worker-testbed": "1.0.12"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "ccxt": "4.5.39",
+    "di-kit": "1.0.18",
+    "di-scoped": "1.0.21",
+    "dotenv": "17.3.1",
+    "functools-kit": "1.0.95",
+    "get-moment-stamp": "1.1.1",
+    "image-size": "1.1.1",
+    "jsdom": "26.1.0",
+    "markdownlint": "0.38.0",
+    "mustache": "4.2.0",
+    "quickchart-js": "3.1.3",
+    "resize-image-buffer": "1.0.0",
+    "sanitize-html": "2.17.0",
+    "stack-trace": "0.0.10",
+    "telegraf": "4.15.3"
+  },
+  "bin": {
+    "@backtest-kit/cli": "./build/index.mjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/template/breakeven.mustache

@@ -0,0 +1,14 @@
+**⚖️ Breakeven**
+
+**Symbol:** `{{symbol}}` ({{position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{priceOpen}}`
+**Take Profit:** `{{priceTakeProfit}}`
+**Stop Loss:** `{{priceStopLoss}}`
+**Signal ID:** `{{signalId}}`
+**Time:** `{{timestamp}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/cancelled.mustache

@@ -0,0 +1,14 @@
+**🚫 Signal Cancelled**
+
+**Symbol:** `{{symbol}}` ({{signal.position}})
+
+**Reason:** `{{reason}}`
+**Entry:** `{{signal.priceOpen}}`
+**Current:** `{{currentPrice}}`
+**Signal ID:** `{{signal.id}}`
+{{#cancelId}}**Cancel ID:** `{{cancelId}}`
+{{/cancelId}}**Time:** `{{createdAt}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/closed.mustache

@@ -0,0 +1,15 @@
+**🏁 Position Closed**
+
+**Symbol:** `{{symbol}}` ({{signal.position}})
+
+**Reason:** `{{closeReason}}`
+**Entry:** `{{pnl.priceOpen}}`
+**Exit:** `{{pnl.priceClose}}`
+**PnL:** {{pnl.pnlPercentage}}%
+**Signal ID:** `{{signal.id}}`
+{{#closeId}}**Close ID:** `{{closeId}}`
+{{/closeId}}**Time:** `{{createdAt}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/opened.mustache

@@ -0,0 +1,15 @@
+**🚀 Position Opened**
+
+**Symbol:** `{{symbol}}` ({{signal.position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{signal.priceOpen}}`
+**Take Profit:** `{{signal.priceTakeProfit}}`
+**Stop Loss:** `{{signal.priceStopLoss}}`
+**TTL:** {{signal.minuteEstimatedTime}} min
+**Signal ID:** `{{signal.id}}`
+**Time:** `{{createdAt}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/partial-loss.mustache

@@ -0,0 +1,15 @@
+**🔻 Partial Loss**
+
+**Symbol:** `{{symbol}}` ({{position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{priceOpen}}`
+**Closed:** {{percentToClose}}%
+**Take Profit:** `{{priceTakeProfit}}`
+**Stop Loss:** `{{priceStopLoss}}`
+**Signal ID:** `{{signalId}}`
+**Time:** `{{timestamp}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/partial-profit.mustache

@@ -0,0 +1,15 @@
+**💚 Partial Profit**
+
+**Symbol:** `{{symbol}}` ({{position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{priceOpen}}`
+**Closed:** {{percentToClose}}%
+**Take Profit:** `{{priceTakeProfit}}`
+**Stop Loss:** `{{priceStopLoss}}`
+**Signal ID:** `{{signalId}}`
+**Time:** `{{timestamp}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/risk.mustache

@@ -0,0 +1,18 @@
+**⛔ Risk Rejected**
+
+**Symbol:** `{{symbol}}` ({{currentSignal.position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{currentSignal.priceOpen}}`
+**Take Profit:** `{{currentSignal.priceTakeProfit}}`
+**Stop Loss:** `{{currentSignal.priceStopLoss}}`
+**Active positions:** {{activePositionCount}}
+{{#rejectionId}}**Rejection ID:** `{{rejectionId}}`
+{{/rejectionId}}**Time:** `{{timestamp}}`
+
+**Reason:**
+{{rejectionNote}}
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/scheduled.mustache

@@ -0,0 +1,15 @@
+**📅 Signal Scheduled**
+
+**Symbol:** `{{symbol}}` ({{signal.position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{signal.priceOpen}}`
+**Take Profit:** `{{signal.priceTakeProfit}}`
+**Stop Loss:** `{{signal.priceStopLoss}}`
+**TTL:** {{signal.minuteEstimatedTime}} min
+**Signal ID:** `{{signal.id}}`
+**Time:** `{{createdAt}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/trailing-stop.mustache

@@ -0,0 +1,15 @@
+**🛡️ Trailing Stop**
+
+**Symbol:** `{{symbol}}` ({{position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{priceOpen}}`
+**Take Profit:** `{{priceTakeProfit}}`
+**Old Stop Loss:** `{{originalPriceStopLoss}}`
+**New Stop Loss:** `{{priceStopLoss}}` ({{percentShift}}%)
+**Signal ID:** `{{signalId}}`
+**Time:** `{{timestamp}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/template/trailing-take.mustache

@@ -0,0 +1,15 @@
+**🎯 Trailing Take**
+
+**Symbol:** `{{symbol}}` ({{position}})
+
+**Current:** `{{currentPrice}}`
+**Entry:** `{{priceOpen}}`
+**Old Take Profit:** `{{originalPriceTakeProfit}}`
+**New Take Profit:** `{{priceTakeProfit}}` ({{percentShift}}%)
+**Stop Loss:** `{{priceStopLoss}}`
+**Signal ID:** `{{signalId}}`
+**Time:** `{{timestamp}}`
+
+{{#backtest}}
+_🧪 Backtest_
+{{/backtest}}

package/types.d.ts

@@ -0,0 +1,228 @@
+import * as functools_kit from 'functools-kit';
+import { Input } from 'telegraf';
+import { TrailingTakeCommit, TrailingStopCommit, BreakevenCommit, PartialProfitCommit, PartialLossCommit, IStrategyTickResultScheduled, IStrategyTickResultCancelled, IStrategyTickResultOpened, IStrategyTickResultClosed, RiskContract } from 'backtest-kit';
+
+interface ILogger {
+    log(topic: string, ...args: any[]): void;
+    debug(topic: string, ...args: any[]): void;
+    info(topic: string, ...args: any[]): void;
+    warn(topic: string, ...args: any[]): void;
+}
+
+declare class LoggerService implements ILogger {
+    private _commonLogger;
+    log: (topic: string, ...args: any[]) => Promise<void>;
+    debug: (topic: string, ...args: any[]) => Promise<void>;
+    info: (topic: string, ...args: any[]) => Promise<void>;
+    warn: (topic: string, ...args: any[]) => Promise<void>;
+    setLogger: (logger: ILogger) => void;
+}
+
+declare class PaperMainService {
+    private loggerService;
+    private exchangeSchemaService;
+    private resolveService;
+    private frontendProviderService;
+    private telegramProviderService;
+    protected init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class LiveMainService {
+    private loggerService;
+    private exchangeSchemaService;
+    private resolveService;
+    private frontendProviderService;
+    private telegramProviderService;
+    protected init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class BacktestMainService {
+    private loggerService;
+    private exchangeSchemaService;
+    private frameSchemaService;
+    private cacheLogicService;
+    private resolveService;
+    private frontendProviderService;
+    private telegramProviderService;
+    protected init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class ExchangeSchemaService {
+    readonly loggerService: LoggerService;
+    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class FrameSchemaService {
+    readonly loggerService: LoggerService;
+    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class ResolveService {
+    private readonly loggerService;
+    readonly DEFAULT_TEMPLATE_DIR: string;
+    readonly OVERRIDE_TEMPLATE_DIR: string;
+    readonly OVERRIDE_MODULES_DIR: string;
+    attachEntryPoint: (entryPoint: string) => Promise<void>;
+}
+
+declare class ErrorService {
+    handleGlobalError: (error: Error) => Promise<void>;
+    private _listenForError;
+    protected init: () => void;
+}
+
+declare class SymbolSchemaService {
+    readonly loggerService: LoggerService;
+    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class FrontendProviderService {
+    private readonly loggerService;
+    enable: (() => () => void) & functools_kit.ISingleshotClearable;
+    disable: () => void;
+    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class TelegramProviderService {
+    private readonly loggerService;
+    private readonly telegramLogicService;
+    enable: (() => () => void) & functools_kit.ISingleshotClearable;
+    disable: () => void;
+    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare class CacheLogicService {
+    private readonly loggerService;
+    execute: (dto: {
+        symbol: string;
+        frameName: string;
+        exchangeName: string;
+    }) => Promise<void>;
+}
+
+type InputFile = ReturnType<typeof Input.fromReadableStream>;
+type Image = string | InputFile;
+declare class TelegramApiService {
+    publish: (channel: string, msg: string, images?: Image[]) => Promise<"Message scheduled for publication" | "Message published successfully">;
+}
+
+declare class QuickchartApiService {
+    readonly loggerService: LoggerService;
+    getChart: (symbol: string, interval: string) => Promise<Buffer<ArrayBufferLike>>;
+}
+
+declare class TelegramWebService {
+    private readonly loggerService;
+    private readonly telegramApiService;
+    private readonly quickchartApiService;
+    publishNotify: (dto: {
+        symbol: string;
+        markdown: string;
+    }) => Promise<void>;
+}
+
+declare class TelegramLogicService {
+    private readonly loggerService;
+    private readonly telegramTemplateService;
+    private readonly telegramWebService;
+    private notifyTrailingTake;
+    private notifyTrailingStop;
+    private notifyBreakeven;
+    private notifyPartialProfit;
+    private notifyPartialLoss;
+    private notifyScheduled;
+    private notifyCancelled;
+    private notifyOpened;
+    private notifyClosed;
+    private notifyRisk;
+    connect: (() => () => void) & functools_kit.ISingleshotClearable;
+}
+
+declare class TelegramTemplateService {
+    readonly loggerService: LoggerService;
+    readonly resolveService: ResolveService;
+    getTrailingTakeMarkdown: (event: TrailingTakeCommit) => Promise<string>;
+    getTrailingStopMarkdown: (event: TrailingStopCommit) => Promise<string>;
+    getBreakevenMarkdown: (event: BreakevenCommit) => Promise<string>;
+    getPartialProfitMarkdown: (event: PartialProfitCommit) => Promise<string>;
+    getPartialLossMarkdown: (event: PartialLossCommit) => Promise<string>;
+    getScheduledMarkdown: (event: IStrategyTickResultScheduled) => Promise<string>;
+    getCancelledMarkdown: (event: IStrategyTickResultCancelled) => Promise<string>;
+    getOpenedMarkdown: (event: IStrategyTickResultOpened) => Promise<string>;
+    getClosedMarkdown: (event: IStrategyTickResultClosed) => Promise<string>;
+    getRiskMarkdown: (event: RiskContract) => Promise<string>;
+}
+
+interface ILiveModule {
+    onTrailingTake(event: TrailingTakeCommit): Promise<void> | void;
+    onTrailingStop(event: TrailingStopCommit): Promise<void> | void;
+    onBreakeven(event: BreakevenCommit): Promise<void> | void;
+    onPartialProfit(event: PartialProfitCommit): Promise<void> | void;
+    onPartialLoss(event: PartialLossCommit): Promise<void> | void;
+    onScheduled(event: IStrategyTickResultScheduled): Promise<void> | void;
+    onCancelled(event: IStrategyTickResultCancelled): Promise<void> | void;
+    onOpened(event: IStrategyTickResultOpened): Promise<void> | void;
+    onClosed(event: IStrategyTickResultClosed): Promise<void> | void;
+    onRisk(event: RiskContract): Promise<void> | void;
+}
+type LiveModule = Partial<ILiveModule>;
+type BaseModule = LiveModule;
+type TBaseModuleCtor = new () => BaseModule;
+
+declare class ModuleConnectionService {
+    readonly loggerService: LoggerService;
+    readonly resolveService: ResolveService;
+    getInstance: ((fileName: string) => Promise<BaseModule>) & functools_kit.IClearableMemoize<string> & functools_kit.IControlMemoize<string, Promise<Partial<ILiveModule>>>;
+}
+
+declare class LiveProviderService {
+    readonly loggerService: LoggerService;
+    readonly moduleConnectionService: ModuleConnectionService;
+    private handleTrailingTake;
+    private handleTrailingStop;
+    private handleBreakeven;
+    private handlePartialProfit;
+    private handlePartialLoss;
+    private handleScheduled;
+    private handleCancelled;
+    private handleOpened;
+    private handleClosed;
+    private handleRisk;
+    enable: (() => (...args: any[]) => any) & functools_kit.ISingleshotClearable;
+    disable: () => void;
+    init: (() => Promise<void>) & functools_kit.ISingleshotClearable;
+}
+
+declare const cli: {
+    telegramTemplateService: TelegramTemplateService;
+    telegramWebService: TelegramWebService;
+    frontendProviderService: FrontendProviderService;
+    telegramProviderService: TelegramProviderService;
+    liveProviderService: LiveProviderService;
+    exchangeSchemaService: ExchangeSchemaService;
+    symbolSchemaService: SymbolSchemaService;
+    frameSchemaService: FrameSchemaService;
+    cacheLogicService: CacheLogicService;
+    telegramLogicService: TelegramLogicService;
+    backtestMainService: BacktestMainService;
+    paperMainService: PaperMainService;
+    liveMainService: LiveMainService;
+    moduleConnectionService: ModuleConnectionService;
+    errorService: ErrorService;
+    loggerService: LoggerService;
+    resolveService: ResolveService;
+    telegramApiService: TelegramApiService;
+    quickchartApiService: QuickchartApiService;
+};
+
+declare enum ExchangeName {
+    DefaultExchange = "default_exchange"
+}
+
+declare enum FrameName {
+    DefaultFrame = "default_frame"
+}
+
+declare function setLogger(logger: ILogger): void;
+
+export { type BaseModule, ExchangeName, FrameName, type ILiveModule, type ILogger, type LiveModule, type TBaseModuleCtor, cli, setLogger };