@mathieuc/tradingview 3.0.1 → 3.3.1

package/package.json

@@ -1,20 +1,18 @@
 {
   "name": "@mathieuc/tradingview",
-  "version": "3.0.1",
+  "version": "3.3.1",
   "description": "Tradingview instant stocks API, indicator alerts, trading bot, and more !",
   "main": "main.js",
   "scripts": {
-    "test-prices": "node ./tests/prices.js",
-    "test-analysis": "node ./tests/analysis.js",
-    "test-indicator": "node ./tests/indicator.js",
-    "test-manual-alerts": "node ./tests/alerts/manualAlert.js",
-    "test-strat-alerts": "node ./tests/alerts/strategyAlert.js",
-    "test": "npm run test-prices"
+    "test": "node test"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Mathieu2301/TradingView-API.git"
   },
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "keywords": [
     "tradingwiew",
     "market",
@@ -36,7 +34,6 @@
     "@mathieuc/console": "^1.0.1",
     "eslint": "^7.25.0",
     "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.22.1",
-    "jsdoc-to-markdown": "^7.1.0"
+    "eslint-plugin-import": "^2.22.1"
   }
 }

package/src/FormData.js

@@ -0,0 +1,36 @@
+/** @class */
+class FormData {
+  #string = '';
+
+  #boundary = '';
+
+  get boundary() {
+    return this.#boundary;
+  }
+
+  constructor() {
+    const random = (Math.random() * 10 ** 20).toString(36);
+    this.#boundary = `${random}`;
+    this.#string = `--${this.boundary}`;
+  }
+
+  /**
+   * Adds a property to the FormData object
+   * @param {string} key Property key
+   * @param {string} value Property value
+   */
+  append(key, value) {
+    this.#string += `\r\nContent-Disposition: form-data; name="${key}"`;
+    this.#string += `\r\n\r\n${value}`;
+    this.#string += `\r\n--${this.boundary}`;
+  }
+
+  /**
+   * @returns {string}
+   */
+  toString() {
+    return `${this.#string}--`;
+  }
+}
+
+module.exports = FormData;

package/src/chart/session.js

@@ -64,7 +64,9 @@ const ChartTypes = {
  * @prop {string} session Session (ex: '24x7')
  * @prop {string} session-correction Session correction
  * @prop {string} session-display Session display (ex: '24x7')
- *
+ */
+
+/**
  * @typedef {Object} MarketInfos
  * @prop {string} series_id            Used series (ex: 'ser_1')
  * @prop {string} base_currency        Base currency (ex: 'BTC')
@@ -113,7 +115,14 @@ const ChartTypes = {
  * @param {import('../client').ClientBridge} client
  */
 module.exports = (client) => class ChartSession {
-  #sessionID = genSessionID('cs');
+  #chartSessionID = genSessionID('cs');
+
+  #replaySessionID = genSessionID('rs');
+
+  #replayMode = false;
+
+  /** @type {Object<string, (): any>} */
+  #replayOKCB = {};
 
   /** Parent client */
   #client = client;
@@ -148,6 +157,11 @@ module.exports = (client) => class ChartSession {
     symbolLoaded: [],
     update: [],
 
+    replayLoaded: [],
+    replayPoint: [],
+    replayResolution: [],
+    replayEnd: [],
+
     event: [],
     error: [],
   };
@@ -167,7 +181,7 @@ module.exports = (client) => class ChartSession {
   }
 
   constructor() {
-    this.#client.sessions[this.#sessionID] = {
+    this.#client.sessions[this.#chartSessionID] = {
       type: 'chart',
       onData: (packet) => {
         if (global.TW_DEBUG) console.log('§90§30§106 CHART SESSION §0 DATA', packet);
@@ -188,7 +202,10 @@ module.exports = (client) => class ChartSession {
         }
 
         if (['timescale_update', 'du'].includes(packet.type)) {
+          const changes = [];
+
           Object.keys(packet.data[1]).forEach((k) => {
+            changes.push(k);
             if (k === '$prices') {
               const periods = packet.data[1].$prices;
               if (!periods || !periods.s) return;
@@ -211,7 +228,7 @@ module.exports = (client) => class ChartSession {
             if (this.#studyListeners[k]) this.#studyListeners[k](packet);
           });
 
-          this.#handleEvent('update');
+          this.#handleEvent('update', changes);
           return;
         }
 
@@ -232,7 +249,47 @@ module.exports = (client) => class ChartSession {
       },
     };
 
-    this.#client.send('chart_create_session', [this.#sessionID]);
+    this.#client.sessions[this.#replaySessionID] = {
+      type: 'replay',
+      onData: (packet) => {
+        if (global.TW_DEBUG) console.log('§90§30§106 REPLAY SESSION §0 DATA', packet);
+
+        if (packet.type === 'replay_ok') {
+          if (this.#replayOKCB[packet.data[1]]) {
+            this.#replayOKCB[packet.data[1]]();
+            delete this.#replayOKCB[packet.data[1]];
+          }
+          return;
+        }
+
+        if (packet.type === 'replay_instance_id') {
+          this.#handleEvent('replayLoaded', packet.data[1]);
+          return;
+        }
+
+        if (packet.type === 'replay_point') {
+          this.#handleEvent('replayPoint', packet.data[1]);
+          return;
+        }
+
+        if (packet.type === 'replay_resolutions') {
+          this.#handleEvent('replayResolution', packet.data[1], packet.data[2]);
+          return;
+        }
+
+        if (packet.type === 'replay_data_end') {
+          this.#handleEvent('replayEnd');
+          return;
+        }
+
+        if (packet.type === 'critical_error') {
+          const [, name, description] = packet.data;
+          this.#handleError('Critical error:', name, description);
+        }
+      },
+    };
+
+    this.#client.send('chart_create_session', [this.#chartSessionID]);
   }
 
   #seriesCreated = false;
@@ -255,7 +312,7 @@ module.exports = (client) => class ChartSession {
     this.#periods = {};
 
     this.#client.send(`${this.#seriesCreated ? 'modify' : 'create'}_series`, [
-      this.#sessionID,
+      this.#chartSessionID,
       '$prices',
       's1',
       `ser_${this.#currentSeries}`,
@@ -278,31 +335,56 @@ module.exports = (client) => class ChartSession {
    * @param {'EUR' | 'USD' | string} [options.currency] Chart currency
    * @param {ChartType} [options.type] Chart custom type
    * @param {ChartInputs} [options.inputs] Chart custom inputs
+   * @param {number} [options.replay] Replay mode starting point (Timestamp)
    */
   setMarket(symbol, options = {}) {
     this.#periods = {};
 
+    if (this.#replayMode) {
+      this.#replayMode = false;
+      this.#client.send('replay_delete_session', [this.#replaySessionID]);
+    }
+
     const symbolInit = {
       symbol: symbol || 'BTCEUR',
       adjustment: options.adjustment || 'splits',
     };
 
     if (options.session) symbolInit.session = options.session;
-
     if (options.currency) symbolInit['currency-id'] = options.currency;
 
-    const chartInit = (options.type && ChartTypes[options.type]) ? {} : symbolInit;
+    if (options.replay) {
+      this.#replayMode = true;
+      this.#client.send('replay_create_session', [this.#replaySessionID]);
+
+      this.#client.send('replay_add_series', [
+        this.#replaySessionID,
+        'req_replay_addseries',
+        `=${JSON.stringify(symbolInit)}`,
+        options.timeframe,
+      ]);
+
+      this.#client.send('replay_reset', [
+        this.#replaySessionID,
+        'req_replay_reset',
+        options.replay,
+      ]);
+    }
+
+    const complex = options.type || options.replay;
+    const chartInit = complex ? {} : symbolInit;
 
-    if (options.type && ChartTypes[options.type]) {
+    if (complex) {
+      if (options.replay) chartInit.replay = this.#replaySessionID;
       chartInit.symbol = symbolInit;
       chartInit.type = ChartTypes[options.type];
-      chartInit.inputs = { ...options.inputs };
+      if (options.type) chartInit.inputs = { ...options.inputs };
     }
 
     this.#currentSeries += 1;
 
     this.#client.send('resolve_symbol', [
-      this.#sessionID,
+      this.#chartSessionID,
       `ser_${this.#currentSeries}`,
       `=${JSON.stringify(chartInit)}`,
     ]);
@@ -316,7 +398,7 @@ module.exports = (client) => class ChartSession {
    */
   setTimezone(timezone) {
     this.#periods = {};
-    this.#client.send('switch_timezone', [this.#sessionID, timezone]);
+    this.#client.send('switch_timezone', [this.#chartSessionID, timezone]);
   }
 
   /**
@@ -324,7 +406,60 @@ module.exports = (client) => class ChartSession {
    * @param {number} number Number of additional periods/candles you want to fetch
    */
   fetchMore(number = 1) {
-    this.#client.send('request_more_data', [this.#sessionID, '$prices', number]);
+    this.#client.send('request_more_data', [this.#chartSessionID, '$prices', number]);
+  }
+
+  /**
+   * Fetch x additional previous periods/candles values
+   * @param {number} number Number of additional periods/candles you want to fetch
+   * @returns {Promise} Raise when the data has been fetched
+   */
+  replayStep(number = 1) {
+    return new Promise((cb) => {
+      if (!this.#replayMode) {
+        this.#handleError('No replay session');
+        return;
+      }
+
+      const reqID = genSessionID('rsq_step');
+      this.#client.send('replay_step', [this.#replaySessionID, reqID, number]);
+      this.#replayOKCB[reqID] = () => { cb(); };
+    });
+  }
+
+  /**
+   * Start fetching a new period/candle every x ms
+   * @param {number} interval Number of additional periods/candles you want to fetch
+   * @returns {Promise} Raise when the replay mode starts
+   */
+  replayStart(interval = 1000) {
+    return new Promise((cb) => {
+      if (!this.#replayMode) {
+        this.#handleError('No replay session');
+        return;
+      }
+
+      const reqID = genSessionID('rsq_start');
+      this.#client.send('replay_start', [this.#replaySessionID, reqID, interval]);
+      this.#replayOKCB[reqID] = () => { cb(); };
+    });
+  }
+
+  /**
+   * Stop fetching a new period/candle every x ms
+   * @returns {Promise} Raise when the replay mode stops
+   */
+  replayStop() {
+    return new Promise((cb) => {
+      if (!this.#replayMode) {
+        this.#handleError('No replay session');
+        return;
+      }
+
+      const reqID = genSessionID('rsq_stop');
+      this.#client.send('replay_stop', [this.#replaySessionID, reqID]);
+      this.#replayOKCB[reqID] = () => { cb(); };
+    });
   }
 
   /**
@@ -338,13 +473,52 @@ module.exports = (client) => class ChartSession {
 
   /**
    * When a chart update happens
-   * @param {() => void} cb
+   * @param {(changes: ('$prices' | string)[]) => void} cb
    * @event
    */
   onUpdate(cb) {
     this.#callbacks.update.push(cb);
   }
 
+  /**
+   * When the replay session is ready
+   * @param {() => void} cb
+   * @event
+   */
+  onReplayLoaded(cb) {
+    this.#callbacks.replayLoaded.push(cb);
+  }
+
+  /**
+   * When the replay session has new resolution
+   * @param {(
+   *   timeframe: import('../types').TimeFrame,
+   *   index: number,
+   * ) => void} cb
+   * @event
+   */
+  onReplayResolution(cb) {
+    this.#callbacks.replayResolution.push(cb);
+  }
+
+  /**
+   * When the replay session ends
+   * @param {() => void} cb
+   * @event
+   */
+  onReplayEnd(cb) {
+    this.#callbacks.replayEnd.push(cb);
+  }
+
+  /**
+   * When the replay session cursor has moved
+   * @param {(index: number) => void} cb
+   * @event
+   */
+  onReplayPoint(cb) {
+    this.#callbacks.replayPoint.push(cb);
+  }
+
   /**
    * When chart error happens
    * @param {(...any) => void} cb Callback
@@ -356,7 +530,7 @@ module.exports = (client) => class ChartSession {
 
   /** @type {ChartSessionBridge} */
   #chartSession = {
-    sessionID: this.#sessionID,
+    sessionID: this.#chartSessionID,
     studyListeners: this.#studyListeners,
     indexes: {},
     send: (t, p) => this.#client.send(t, p),
@@ -366,7 +540,9 @@ module.exports = (client) => class ChartSession {
 
   /** Delete the chart session */
   delete() {
-    this.#client.send('quote_delete_session', [this.#sessionID]);
-    delete this.#client.sessions[this.#sessionID];
+    if (this.#replayMode) this.#client.send('replay_delete_session', [this.#replaySessionID]);
+    this.#client.send('chart_delete_session', [this.#chartSessionID]);
+    delete this.#client.sessions[this.#chartSessionID];
+    this.#replayMode = false;
   }
 };

package/src/chart/study.js

@@ -16,11 +16,11 @@ function getInputs(options) {
     if (options.pineId) pineInputs.pineId = options.pineId;
     if (options.pineVersion) pineInputs.pineVersion = options.pineVersion;
 
-    Object.keys(options.inputs).forEach((inputID) => {
+    Object.keys(options.inputs).forEach((inputID, n) => {
       const input = options.inputs[inputID];
 
       pineInputs[inputID] = {
-        v: input.value,
+        v: (input.type !== 'color') ? input.value : n,
         f: input.isFake,
         t: input.type,
       };
@@ -35,80 +35,80 @@ function getInputs(options) {
 /**
  * @typedef {Object} TradeReport Trade report
 
- * @property {Object} entry Trade entry
- * @property {string} entry.name Trade name
- * @property {'long' | 'short'} entry.type Entry type (long/short)
- * @property {number} entry.value Entry price value
- * @property {number} entry.time Entry timestamp
-
- * @property {Object} exit Trade exit
- * @property {'' | string} exit.name Trade name ('' if false exit)
- * @property {number} exit.value Exit price value
- * @property {number} exit.time Exit timestamp
-
- * @property {number} quantity Trade quantity
- * @property {RelAbsValue} profit Trade profit
- * @property {RelAbsValue} cumulative Trade cummulative profit
- * @property {RelAbsValue} runup Trade run-up
- * @property {RelAbsValue} drawdown Trade drawdown
+ * @prop {Object} entry Trade entry
+ * @prop {string} entry.name Trade name
+ * @prop {'long' | 'short'} entry.type Entry type (long/short)
+ * @prop {number} entry.value Entry price value
+ * @prop {number} entry.time Entry timestamp
+
+ * @prop {Object} exit Trade exit
+ * @prop {'' | string} exit.name Trade name ('' if false exit)
+ * @prop {number} exit.value Exit price value
+ * @prop {number} exit.time Exit timestamp
+
+ * @prop {number} quantity Trade quantity
+ * @prop {RelAbsValue} profit Trade profit
+ * @prop {RelAbsValue} cumulative Trade cummulative profit
+ * @prop {RelAbsValue} runup Trade run-up
+ * @prop {RelAbsValue} drawdown Trade drawdown
  */
 
 /**
  * @typedef {Object} PerfReport
- * @property {number} avgBarsInTrade Average bars in trade
- * @property {number} avgBarsInWinTrade Average bars in winning trade
- * @property {number} avgBarsInLossTrade Average bars in losing trade
- * @property {number} avgTrade Average trade gain
- * @property {number} avgTradePercent Average trade performace
- * @property {number} avgLosTrade Average losing trade gain
- * @property {number} avgLosTradePercent Average losing trade performace
- * @property {number} avgWinTrade Average winning trade gain
- * @property {number} avgWinTradePercent Average winning trade performace
- * @property {number} commissionPaid Commission paid
- * @property {number} grossLoss Gross loss value
- * @property {number} grossLossPercent Gross loss percent
- * @property {number} grossProfit Gross profit
- * @property {number} grossProfitPercent Gross profit percent
- * @property {number} largestLosTrade Largest losing trade gain
- * @property {number} largestLosTradePercent Largent losing trade performance (percentage)
- * @property {number} largestWinTrade Largest winning trade gain
- * @property {number} largestWinTradePercent Largest winning trade performance (percentage)
- * @property {number} marginCalls Margin calls
- * @property {number} maxContractsHeld Max Contracts Held
- * @property {number} netProfit Net profit
- * @property {number} netProfitPercent Net performance (percentage)
- * @property {number} numberOfLosingTrades Number of losing trades
- * @property {number} numberOfWiningTrades Number of winning trades
- * @property {number} percentProfitable Strategy winrate
- * @property {number} profitFactor Profit factor
- * @property {number} ratioAvgWinAvgLoss Ratio Average Win / Average Loss
- * @property {number} totalOpenTrades Total open trades
- * @property {number} totalTrades Total trades
+ * @prop {number} avgBarsInTrade Average bars in trade
+ * @prop {number} avgBarsInWinTrade Average bars in winning trade
+ * @prop {number} avgBarsInLossTrade Average bars in losing trade
+ * @prop {number} avgTrade Average trade gain
+ * @prop {number} avgTradePercent Average trade performace
+ * @prop {number} avgLosTrade Average losing trade gain
+ * @prop {number} avgLosTradePercent Average losing trade performace
+ * @prop {number} avgWinTrade Average winning trade gain
+ * @prop {number} avgWinTradePercent Average winning trade performace
+ * @prop {number} commissionPaid Commission paid
+ * @prop {number} grossLoss Gross loss value
+ * @prop {number} grossLossPercent Gross loss percent
+ * @prop {number} grossProfit Gross profit
+ * @prop {number} grossProfitPercent Gross profit percent
+ * @prop {number} largestLosTrade Largest losing trade gain
+ * @prop {number} largestLosTradePercent Largent losing trade performance (percentage)
+ * @prop {number} largestWinTrade Largest winning trade gain
+ * @prop {number} largestWinTradePercent Largest winning trade performance (percentage)
+ * @prop {number} marginCalls Margin calls
+ * @prop {number} maxContractsHeld Max Contracts Held
+ * @prop {number} netProfit Net profit
+ * @prop {number} netProfitPercent Net performance (percentage)
+ * @prop {number} numberOfLosingTrades Number of losing trades
+ * @prop {number} numberOfWiningTrades Number of winning trades
+ * @prop {number} percentProfitable Strategy winrate
+ * @prop {number} profitFactor Profit factor
+ * @prop {number} ratioAvgWinAvgLoss Ratio Average Win / Average Loss
+ * @prop {number} totalOpenTrades Total open trades
+ * @prop {number} totalTrades Total trades
 */
 
 /**
  * @typedef {Object} StrategyReport
- * @property {'EUR' | 'USD' | 'JPY' | '' | 'CHF'} [currency] Selected currency
- * @property {TradeReport[]} trades Trade list starting by the last
- * @property {Object} history History Chart value
- * @property {number[]} [history.buyHold] Buy hold values
- * @property {number[]} [history.buyHoldPercent] Buy hold percent values
- * @property {number[]} [history.drawDown] Drawdown values
- * @property {number[]} [history.drawDownPercent] Drawdown percent values
- * @property {number[]} [history.equity] Equity values
- * @property {number[]} [history.equityPercent] Equity percent values
- * @property {Object} performance Strategy performance
- * @property {PerfReport} [performance.all] Strategy long/short performances
- * @property {PerfReport} [performance.long] Strategy long performances
- * @property {PerfReport} [performance.short] Strategy short performances
- * @property {number} [performance.buyHoldReturn] Strategy Buy & Hold Return
- * @property {number} [performance.buyHoldReturnPercent] Strategy Buy & Hold Return percent
- * @property {number} [performance.maxDrawDown] Strategy max drawdown
- * @property {number} [performance.maxDrawDownPercent] Strategy max drawdown percent
- * @property {number} [performance.openPL] Strategy Open P&L (Profit And Loss)
- * @property {number} [performance.openPLPercent] Strategy Open P&L (Profit And Loss) percent
- * @property {number} [performance.sharpeRatio] Strategy Sharpe Ratio
- * @property {number} [performance.sortinoRatio] Strategy Sortino Ratio
+ * @prop {'EUR' | 'USD' | 'JPY' | '' | 'CHF'} [currency] Selected currency
+ * @prop {TradeReport[]} trades Trade list starting by the last
+ * @prop {Object} history History Chart value
+ * @prop {number[]} [history.buyHold] Buy hold values
+ * @prop {number[]} [history.buyHoldPercent] Buy hold percent values
+ * @prop {number[]} [history.drawDown] Drawdown values
+ * @prop {number[]} [history.drawDownPercent] Drawdown percent values
+ * @prop {number[]} [history.equity] Equity values
+ * @prop {number[]} [history.equityPercent] Equity percent values
+ * @prop {Object} performance Strategy performance
+ * @prop {PerfReport} [performance.all] Strategy long/short performances
+ * @prop {PerfReport} [performance.long] Strategy long performances
+ * @prop {PerfReport} [performance.short] Strategy short performances
+ * @prop {number} [performance.buyHoldReturn] Strategy Buy & Hold Return
+ * @prop {number} [performance.buyHoldReturnPercent] Strategy Buy & Hold Return percent
+ * @prop {number} [performance.maxDrawDown] Strategy max drawdown
+ * @prop {number} [performance.maxDrawDownPercent] Strategy max drawdown percent
+ * @prop {number} [performance.openPL] Strategy Open P&L (Profit And Loss)
+ * @prop {number} [performance.openPLPercent] Strategy Open P&L (Profit And Loss) percent
+ * @prop {number} [performance.sharpeRatio] Strategy Sharpe Ratio
+ * @prop {number} [performance.sortinoRatio] Strategy Sortino Ratio
  */
 
 /**

package/src/classes/BuiltInIndicator.js

@@ -68,6 +68,7 @@ const defaultValues = {
   },
 };
 
+/** @class */
 module.exports = class BuiltInIndicator {
   /** @type {BuiltInIndicatorType} */
   #type;

package/src/classes/PineIndicator.js

@@ -4,7 +4,9 @@
  * @property {string} inline Input inline name
  * @property {string} [internalID] Input internal ID
  * @property {string} [tooltip] Input tooltip
- * @property {'text' | 'source' | 'integer' | 'float' | 'resolution' | 'bool'} type Input type
+ * @property {'text' | 'source' | 'integer'
+ *  | 'float' | 'resolution' | 'bool' | 'color'
+ * } type Input type
  * @property {string | number | boolean} value Input default value
  * @property {boolean} isHidden If the input is hidden
  * @property {boolean} isFake If the input is fake
@@ -26,6 +28,8 @@
  * @typedef {'Script@tv-scripting-101!'
  *  | 'StrategyScript@tv-scripting-101!'} IndicatorType Indicator type
  */
+
+/** @class */
 module.exports = class PineIndicator {
   #options;
 
@@ -113,12 +117,8 @@ module.exports = class PineIndicator {
         text: 'String',
       };
 
-      if (
-        (input.type === 'bool' && typeof value !== 'boolean')
-        || (input.type === 'integer' && typeof value !== 'number')
-        || (input.type === 'float' && typeof value !== 'number')
-        || (input.type === 'text' && typeof value !== 'string')
-      ) {
+      // eslint-disable-next-line valid-typeof
+      if (types[input.type] && typeof value !== types[input.type].toLowerCase()) {
         throw new Error(`Input '${input.name}' (${propI}) must be a ${types[input.type]} !`);
       }