@mathieuc/tradingview 3.0.1 → 3.3.1

package/src/protocol.js

@@ -6,14 +6,18 @@ const JSZip = require('jszip');
  * @prop {[session: string, {}]} [p] Packet data
  */
 
+const cleanerRgx = /~h~/g;
+const splitterRgx = /~m~[0-9]{1,}~m~/g;
+
 module.exports = {
   /**
    * Parse websocket packet
+   * @function parseWSPacket
    * @param {string} str Websocket raw data
    * @returns {TWPacket[]} TradingView packets
    */
   parseWSPacket(str) {
-    return str.replace(/~h~/g, '').split(/~m~[0-9]{1,}~m~/g)
+    return str.replace(cleanerRgx, '').split(splitterRgx)
       .map((p) => {
         if (!p) return false;
         try {
@@ -28,6 +32,7 @@ module.exports = {
 
   /**
    * Format websocket packet
+   * @function formatWSPacket
    * @param {TWPacket} packet TradingView packet
    * @returns {string} Websocket raw data
    */
@@ -40,6 +45,7 @@ module.exports = {
 
   /**
    * Parse compressed data
+   * @function parseCompressed
    * @param {string} data Compressed data
    * @returns {Promise<{}>} Parsed data
    */

package/src/quote/session.js

@@ -120,5 +120,6 @@ module.exports = (client) => class QuoteSession {
   /** Delete the quote session */
   delete() {
     this.#client.send('quote_delete_session', [this.#sessionID]);
+    delete this.#client.sessions[this.#sessionID];
   }
 };

package/src/request.js

@@ -0,0 +1,37 @@
+const https = require('https');
+
+/**
+ * @param {https.RequestOptions} options HTTPS Request options
+ * @param {boolean} [raw] Get raw or JSON data
+ * @param {string} [content] Request body content
+ * @returns {Promise<{ data: (string | object | array), cookies: string[] }>} Result
+ */
+function request(options = {}, raw = false, content = '') {
+  return new Promise((cb, err) => {
+    const req = https.request(options, (res) => {
+      let data = '';
+      res.on('data', (c) => { data += c; });
+      res.on('end', () => {
+        if (raw) {
+          cb({ data, cookies: res.headers['set-cookie'] });
+          return;
+        }
+
+        try {
+          data = JSON.parse(data);
+        } catch (error) {
+          console.log(data);
+          err(new Error('Can\'t parse server response'));
+          return;
+        }
+
+        cb({ data, cookies: res.headers['set-cookie'] });
+      });
+    });
+
+    req.on('error', err);
+    req.end(content);
+  });
+}
+
+module.exports = request;

package/src/types.js

@@ -1,6 +1,8 @@
 /**
  * @typedef {string} MarketSymbol Market symbol (like: 'BTCEUR' or 'KRAKEN:BTCEUR')
- *
+ */
+
+/**
  * @typedef {'Etc/UTC' | 'exchange'
  * | 'Pacific/Honolulu' | 'America/Juneau' | 'America/Los_Angeles'
  * | 'America/Phoenix' | 'America/Vancouver' | 'US/Mountain'
@@ -23,7 +25,9 @@
  * | 'Asia/Taipei' | 'Asia/Seoul' | 'Asia/Tokyo' | 'Australia/Brisbane'
  * | 'Australia/Adelaide' | 'Australia/Sydney' | 'Pacific/Norfolk'
  * | 'Pacific/Auckland' | 'Pacific/Fakaofo' | 'Pacific/Chatham'} Timezone (Chart) timezone
- *
+ */
+
+/**
  * @typedef {'1' | '3' | '5' | '15' | '30'
  * | '45' | '60' | '120' | '180' | '240'
  * | '1D' | '1W' | '1M' | 'D' | 'W' | 'M'} TimeFrame

package/src/utils.js

@@ -1,4 +1,10 @@
 module.exports = {
+  /**
+   * Generates a session id
+   * @function genSessionID
+   * @param {String} type Session type
+   * @returns {string}
+   */
   genSessionID(type = 'xs') {
     let r = '';
     const c = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';

package/test.js

@@ -1,155 +1,66 @@
+/* eslint-disable no-continue */
+/* eslint-disable no-await-in-loop */
+/* eslint-disable import/no-dynamic-require */
+/* eslint-disable no-restricted-syntax */
+/* eslint-disable global-require */
+
+const fs = require('fs');
 require('@mathieuc/console')(
   '§', // Character you want to use (defaut: '§')
   true, // Active timestamp (defaut: false)
 );
 
-const TradingView = require('./main');
-
-const log = (...msg) => console.log('§90§30§103 TEST §0', ...msg);
-
-const client = new TradingView.Client({ DEBUG: true });
-
-client.onEvent((event, data) => {
-  log('EVENT:', event, data);
-});
-
-client.onError((...error) => {
-  log(...error);
-});
-
-// const quoteSession = new client.Session.Quote({
-//   fields: 'price',
-// });
-
-// const BTC = new quoteSession.Market('BTCEUR');
-
-// BTC.onLoaded(() => {
-//   log('BTCEUR LOADED !');
-// });
-
-// BTC.onData((data) => {
-//   log('BTCEUR DATA:', data);
-// });
-
-// BTC.onError((...err) => {
-//   log('BTCEUR ERROR:', err);
-// });
-
-const chart = new client.Session.Chart();
-chart.setMarket('COINBASE:BTCEUR');
-chart.setSeries('60');
-
-chart.onSymbolLoaded(() => {
-  log('Market loaded:', chart.infos.full_name);
-});
-
-chart.onError((...err) => {
-  log('CHART ERROR:', ...err);
-});
-
-chart.onUpdate(() => {
-  const last = chart.periods[0];
-  if (!last) return;
-  log(`Market last period: ${last.close}`);
-});
-
-TradingView.getIndicator('STD;Supertrend%Strategy').then((indicator) => {
-  indicator.setOption('commission_type', 'percent');
-  indicator.setOption('commission_value', 0);
-  indicator.setOption('initial_capital', 25000);
-  indicator.setOption('default_qty_value', 20);
-  indicator.setOption('default_qty_type', 'percent_of_equity');
-  indicator.setOption('currency', 'EUR');
-  indicator.setOption('pyramiding', 10);
-
-  const SuperTrend = new chart.Study(indicator);
-
-  SuperTrend.onReady(() => {
-    log('SuperTrend ready !');
-  });
-
-  SuperTrend.onError((...err) => {
-    log('SuperTrend ERROR:', err[0]);
-  });
-
-  // let QTY = 10;
-  // setInterval(() => {
-  //   QTY += 10;
-  //   console.log('TRY WITH', QTY, '%');
-  //   indicator.setOption('default_qty_value', QTY);
-
-  //   SuperTrend.setIndicator(indicator);
-  // }, 5000);
-
-  SuperTrend.onUpdate((changes) => {
-    // MarketCipher B is a strategy so it sends a strategy report
-    log('SuperTrend update:', changes);
-
-    const perfReport = SuperTrend.strategyReport.performance;
-
-    log('Performance report:', {
-      total: {
-        trades: perfReport.all.totalTrades,
-        perf: `${Math.round(perfReport.all.netProfitPercent * 10000) / 100} %`,
-        profit: `${Math.round(perfReport.all.netProfit * 1000) / 1000} €`,
-      },
-      buy: {
-        trades: perfReport.long.totalTrades,
-        perf: `${Math.round(perfReport.long.netProfitPercent * 10000) / 100} %`,
-        profit: `${Math.round(perfReport.long.netProfit * 1000) / 1000} €`,
-      },
-      sell: {
-        trades: perfReport.short.totalTrades,
-        perf: `${Math.round(perfReport.short.netProfitPercent * 10000) / 100} %`,
-        profit: `${Math.round(perfReport.short.netProfit * 1000) / 1000} €`,
-      },
-    });
-
-    if (changes.includes('fullReport')) {
-      log('Last trade:', SuperTrend.strategyReport.trades[0]);
-      // Do something...
-
-      // // Remove SuperTrend strategy from the chart
-      // SuperTrend.remove();
-    }
-  });
-});
-
-TradingView.getIndicator('PUB;uA35GeckoTA2EfgI63SD2WCSmca4njxp').then((indicator) => {
-  indicator.setOption('Show_WT_Hidden_Divergences', true);
-  indicator.setOption('Show_Stoch_Regular_Divergences', true);
-  indicator.setOption('Show_Stoch_Hidden_Divergences', true);
-
-  const CipherB = new chart.Study(indicator);
-
-  CipherB.onReady(() => {
-    log('MarketCipher B ready !');
-  });
-
-  CipherB.onError((...err) => {
-    log('MarketCipher B ERROR:', err[0]);
-  });
-
-  CipherB.onUpdate(() => {
-    const last = CipherB.periods[0];
-    // MarketCipher B is not a strategy so it only sends plots values
-    log('MarketCipher B last values:', {
-      VWAP: Math.round(last.VWAP * 1000) / 1000,
-      moneyFlow: (last.RSIMFIArea >= 0) ? 'POSITIVE' : 'NEGATIVE',
-      buyCircle: last.Buy_and_sell_circle && last.VWAP > 0,
-      sellCircle: last.Buy_and_sell_circle && last.VWAP < 0,
-    });
-
-    // Do something...
+const TESTS = {};
+
+function err(name) {
+  return (...msg) => {
+    TESTS[name].errors += 1;
+    console.error('§30§101 > §0', ...msg);
+  };
+}
+
+function warn(name) {
+  return (...msg) => {
+    TESTS[name].warnings += 1;
+    console.warn('§30§103 > §0', ...msg);
+  };
+}
+
+function log() {
+  return (...msg) => console.log('§30§107 > §0', ...msg);
+}
+
+function success() {
+  return (...msg) => console.info('§30§102 > §0', ...msg);
+}
+
+(async () => {
+  console.info('§90§30§104 ==== Starting tests ==== §0');
+
+  for (const file of fs.readdirSync('./tests').filter((f) => f.endsWith('.js'))) {
+    if (process.argv[2] && !file.startsWith(process.argv[2])) continue;
+    const test = require(`./tests/${file}`);
+    const name = file.replace(/\.js/g, '');
+    TESTS[name] = { errors: 0, warnings: 0 };
+    console.log(`§90§30§107 ${name}`);
+    await new Promise((cb) => test(log(), success(), warn(name), err(name), cb));
+  }
+
+  console.info('§90§30§104 ==== ALL TESTS DONE ==== §0\n');
+  Object.keys(TESTS).forEach((t) => {
+    let color = '2';
+    if (TESTS[t].warnings) color = '3';
+    if (TESTS[t].errors) color = '1';
+
+    console.info(`§90§30§10${color} ${t} §0 §91E§0: ${TESTS[t].errors}§0 §93W§0: ${TESTS[t].warnings}`);
+    // console.info(` - §91 Errors:§0 ${TESTS[t].errors}`);
+    // console.info(` - §93 Warnings:§0 ${TESTS[t].warnings}`);
   });
-});
 
-// setTimeout(() => {
-//   log('Set timeframe to 240...');
-//   chart.setSeries('240');
-// }, 5000);
+  process.exit(0);
+})();
 
-// setInterval(() => {
-//   log('Fetch 100 more periods...');
-//   chart.fetchMore(100);
-// }, 10000);
+setTimeout(() => {
+  console.log('§30§101 TIMEOUT §0');
+  throw new Error('Timeout');
+}, 60000);

package/tests/1. Search.js

@@ -0,0 +1,18 @@
+const TradingView = require('../main');
+
+module.exports = async (log, success, warn, err, cb) => {
+  log('Searching market: \'BINANCE:\'');
+  const markets = await TradingView.searchMarket('BINANCE:');
+  success('Found', markets.length, 'markets');
+
+  log('Searching indicator: \'RSI\'');
+  const indicators = await TradingView.searchIndicator('RSI');
+  success('Found', indicators.length, 'indicators');
+
+  if (markets.length < 10 || indicators.length < 10) {
+    err('Not enough results');
+    throw new Error('Not enough results');
+  }
+
+  cb();
+};

package/tests/2. QuoteSession.js

@@ -0,0 +1,54 @@
+const TradingView = require('../main');
+
+module.exports = (log, success, warn, err, cb) => {
+  const client = new TradingView.Client();
+
+  client.onError((...error) => {
+    err('Client error', ...error);
+    throw new Error('Client error');
+  });
+
+  const quoteSession = new client.Session.Quote({
+    fields: 'all',
+  });
+
+  const BTC = new quoteSession.Market('BTCEUR');
+
+  BTC.onLoaded(() => {
+    success('BTCEUR LOADED');
+  });
+
+  const keys = [
+    'volume', 'update_mode', 'type', 'timezone',
+    'short_name', 'rtc_time', 'rtc', 'rchp', 'ch',
+    'rch', 'provider_id', 'pro_name', 'pricescale',
+    'prev_close_price', 'original_name', 'lp',
+    'open_price', 'minmove2', 'minmov', 'lp_time',
+    'low_price', 'is_tradable', 'high_price',
+    'fractional', 'exchange', 'description',
+    'current_session', 'currency_code', 'chp',
+    'currency-logoid', 'base-currency-logoid',
+  ];
+
+  BTC.onData(async (data) => {
+    const rsKeys = Object.keys(data);
+    success('BTCEUR DATA');
+    if (rsKeys.length <= 2) return;
+
+    keys.forEach((k) => {
+      if (!rsKeys.includes(k)) {
+        err(`Missing '${k}' key in`, rsKeys);
+        throw new Error('Missing key');
+      }
+    });
+
+    quoteSession.delete();
+    await client.end();
+    cb();
+  });
+
+  BTC.onError((...error) => {
+    err('BTCEUR ERROR:', error);
+    throw new Error('Missing key');
+  });
+};

package/tests/3. SimpleChart.js

@@ -0,0 +1,61 @@
+const TradingView = require('../main');
+
+module.exports = async (log, success, warn, err, cb) => {
+  const client = new TradingView.Client();
+
+  client.onError((...error) => {
+    err('Client error', error);
+    throw new Error('Client error');
+  });
+
+  const chart = new client.Session.Chart();
+
+  chart.setMarket('BINANCE:BTCEUR', { // Set the market
+    timeframe: 'D',
+  });
+
+  chart.onError((...error) => {
+    err('Chart error', error);
+    throw new Error('Chart error');
+  });
+
+  chart.onSymbolLoaded(() => { // When the symbol is successfully loaded
+    success(`Market "${chart.infos.description}" loaded !`);
+  });
+
+  // Wait 3 seconds and set the market to BINANCE:ETHEUR
+  setTimeout(() => {
+    log('Setting market to BINANCE:ETHEUR...');
+    chart.setMarket('BINANCE:ETHEUR', {
+      timeframe: 'D',
+    });
+  }, 2000);
+
+  // Wait 4 seconds and set the timeframe to 15 minutes
+  setTimeout(() => {
+    log('Setting timeframe to 15 minutes...');
+    chart.setSeries('15');
+  }, 3000);
+
+  // Wait 5 seconds and set the chart type to "Heikin Ashi"
+  setTimeout(() => {
+    log('Setting the chart type to "Heikin Ashi"...');
+    chart.setMarket('BINANCE:ETHEUR', {
+      timeframe: 'D',
+      type: 'HeikinAshi',
+    });
+  }, 4000);
+
+  // Wait 7 seconds and close the chart
+  setTimeout(() => {
+    log('Closing the chart...');
+    chart.delete();
+  }, 5000);
+
+  // Wait 8 seconds and close the client
+  setTimeout(async () => {
+    log('Closing the client...');
+    await client.end();
+    cb();
+  }, 6000);
+};

package/tests/4. Indicators.js

@@ -0,0 +1,100 @@
+const TradingView = require('../main');
+
+module.exports = async (log, success, warn, err, cb) => {
+  const client = new TradingView.Client();
+
+  client.onError((...error) => {
+    err('Client error', error);
+    throw new Error('Client error');
+  });
+
+  const chart = new client.Session.Chart();
+  chart.setMarket('BINANCE:BTCEUR', {
+    timeframe: '60',
+  });
+
+  chart.onError((...error) => {
+    err('Chart error', error);
+    throw new Error('Chart error');
+  });
+
+  TradingView.getIndicator('STD;Supertrend%Strategy').then((indicator) => {
+    indicator.setOption('commission_type', 'percent');
+    indicator.setOption('commission_value', 0);
+    indicator.setOption('initial_capital', 25000);
+    indicator.setOption('default_qty_value', 20);
+    indicator.setOption('default_qty_type', 'percent_of_equity');
+    indicator.setOption('currency', 'EUR');
+    indicator.setOption('pyramiding', 10);
+
+    const SuperTrend = new chart.Study(indicator);
+
+    SuperTrend.onError((...error) => {
+      err('SuperTrend error', error[0]);
+      throw new Error('SuperTrend error');
+    });
+
+    let QTY = 10;
+
+    SuperTrend.onUpdate(async () => {
+      // MarketCipher B is a strategy so it sends a strategy report
+      const perfReport = SuperTrend.strategyReport.performance;
+
+      success('Performances:', {
+        total: {
+          trades: perfReport.all.totalTrades,
+          perf: `${Math.round(perfReport.all.netProfitPercent * 10000) / 100} %`,
+        },
+        buy: {
+          trades: perfReport.long.totalTrades,
+          perf: `${Math.round(perfReport.long.netProfitPercent * 10000) / 100} %`,
+        },
+        sell: {
+          trades: perfReport.short.totalTrades,
+          perf: `${Math.round(perfReport.short.netProfitPercent * 10000) / 100} %`,
+        },
+      });
+
+      if (QTY >= 50) {
+        SuperTrend.remove();
+        chart.delete();
+        await client.end();
+        cb();
+        return;
+      }
+
+      QTY += 10;
+      log('TRY WITH', QTY, '%');
+      setTimeout(() => {
+        indicator.setOption('default_qty_value', QTY);
+        SuperTrend.setIndicator(indicator);
+      }, 1000);
+    });
+  });
+
+  TradingView.getIndicator('PUB;uA35GeckoTA2EfgI63SD2WCSmca4njxp').then((indicator) => {
+    indicator.setOption('Show_WT_Hidden_Divergences', true);
+    indicator.setOption('Show_Stoch_Regular_Divergences', true);
+    indicator.setOption('Show_Stoch_Hidden_Divergences', true);
+
+    const CipherB = new chart.Study(indicator);
+
+    CipherB.onError((...error) => {
+      err('MarketCipher B error:', error[0]);
+      throw new Error('MarketCipher B error');
+    });
+
+    CipherB.onUpdate(() => {
+      const last = CipherB.periods[0];
+      // MarketCipher B is not a strategy so it only sends plots values
+      success('MarketCipher B last values:', {
+        VWAP: Math.round(last.VWAP * 1000) / 1000,
+        moneyFlow: (last.RSIMFIArea >= 0) ? 'POSITIVE' : 'NEGATIVE',
+        buyCircle: last.Buy_and_sell_circle && last.VWAP > 0,
+        sellCircle: last.Buy_and_sell_circle && last.VWAP < 0,
+      });
+
+      CipherB.remove();
+    });
+  });
+};

package/tests/5. BuiltInIndicator.js

@@ -0,0 +1,41 @@
+const TradingView = require('../main');
+
+module.exports = async (log, success, warn, err, cb) => {
+  const client = new TradingView.Client();
+
+  client.onError((...error) => {
+    err('Client error', error);
+    throw new Error('Client error');
+  });
+
+  const chart = new client.Session.Chart();
+  chart.setMarket('BINANCE:BTCEUR', {
+    timeframe: '60',
+  });
+
+  chart.onError((...error) => {
+    err('Chart error', error);
+    throw new Error('Chart error');
+  });
+
+  const volumeProfile = new TradingView.BuiltInIndicator('VbPFixed@tv-basicstudies-139!');
+
+  volumeProfile.setOption('first_bar_time', Date.now() - 10 ** 8);
+
+  const VOL = new chart.Study(volumeProfile);
+  VOL.onUpdate(async () => {
+    VOL.graphic.horizHists
+      .filter((h) => h.lastBarTime === 0) // We only keep recent volume infos
+      .sort((a, b) => b.priceHigh - a.priceHigh)
+      .forEach((h) => {
+        success(
+          `~ ${Math.round((h.priceHigh + h.priceLow) / 2)} € :`,
+          `${'_'.repeat(h.rate[0] / 3)}${'_'.repeat(h.rate[1] / 3)}`,
+        );
+      });
+
+    chart.delete();
+    await client.end();
+    cb();
+  });
+};

package/tests/6. FakeReplayMode.js

@@ -0,0 +1,59 @@
+const TradingView = require('../main');
+
+module.exports = async (log, success, warn, err, cb) => {
+  const client = new TradingView.Client();
+
+  client.onError((...error) => {
+    err('Client error', error);
+    throw new Error('Client error');
+  });
+
+  const chart = new client.Session.Chart();
+  chart.setMarket('BINANCE:BTCEUR', {
+    timeframe: 'D',
+    range: -1,
+    to: Math.round(Date.now() / 1000) - 86400 * 7,
+  });
+
+  chart.onError((...error) => {
+    err('Chart error', error);
+    throw new Error('Chart error');
+  });
+
+  let interval = NaN;
+  let consec = 1;
+  let lastTime = 0;
+
+  chart.onUpdate(async () => {
+    const times = chart.periods.map((p) => p.time);
+
+    if (lastTime === times[0]) {
+      consec += 1;
+      warn(`Same lastTime ${lastTime}, ${consec} times in a row`);
+    } else consec = 1;
+    [lastTime] = times;
+
+    if (consec >= 10) {
+      chart.delete();
+      await client.end();
+      cb();
+    }
+
+    const intrval = times[0] - times[1];
+    if (Number.isNaN(interval) && times.length >= 2) interval = intrval;
+
+    if (!Number.isNaN(interval) && interval !== intrval) {
+      throw new Error(`Wrong interval: ${intrval} (should be ${interval})`);
+    }
+
+    log('Next ->', times[0]);
+
+    if ((times[0] + 86400) * 1000 > Date.now()) {
+      chart.delete();
+      await client.end();
+      cb();
+    }
+
+    chart.fetchMore(-1);
+  });
+};