@mathieuc/tradingview 3.0.1 → 3.2.0

package/tests/8. CustomChartTypes.js

@@ -0,0 +1,115 @@
+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.onError((...error) => {
+    err('Chart error', error);
+    throw new Error('Chart error');
+  });
+
+  /* (0s) Heikin Ashi chart */
+  setTimeout(() => {
+    log('Setting chart type to: HeikinAshi');
+
+    chart.setMarket('BINANCE:BTCEUR', {
+      type: 'HeikinAshi',
+      timeframe: 'D',
+    });
+  }, 0);
+
+  /* (1s) Renko chart */
+  setTimeout(() => {
+    log('Setting chart type to: Renko');
+
+    chart.setMarket('BINANCE:BTCEUR', {
+      type: 'Renko',
+      timeframe: 'D',
+      inputs: {
+        source: 'close',
+        sources: 'Close',
+        boxSize: 3,
+        style: 'ATR',
+        atrLength: 14,
+        wicks: true,
+      },
+    });
+  }, 1000);
+
+  /* (2s) Line Break chart */
+  setTimeout(() => {
+    log('Setting chart type to: LineBreak');
+
+    chart.setMarket('BINANCE:BTCEUR', {
+      type: 'LineBreak',
+      timeframe: 'D',
+      inputs: {
+        source: 'close',
+        lb: 3,
+      },
+    });
+  }, 2000);
+
+  /* (3s) Kagi chart */
+  setTimeout(() => {
+    log('Setting chart type to: Kagi');
+
+    chart.setMarket('BINANCE:BTCEUR', {
+      type: 'Kagi',
+      timeframe: 'D',
+      inputs: {
+        source: 'close',
+        style: 'ATR',
+        atrLength: 14,
+        reversalAmount: 1,
+      },
+    });
+  }, 3000);
+
+  /* (4s) Point & Figure chart */
+  setTimeout(() => {
+    log('Setting chart type to: PointAndFigure');
+
+    chart.setMarket('BINANCE:BTCEUR', {
+      type: 'PointAndFigure',
+      timeframe: 'D',
+      inputs: {
+        sources: 'Close',
+        reversalAmount: 3,
+        boxSize: 1,
+        style: 'ATR',
+        atrLength: 14,
+        oneStepBackBuilding: false,
+      },
+    });
+  }, 4000);
+
+  /* (5s) Range chart */
+  setTimeout(() => {
+    log('Setting chart type to: Range');
+
+    chart.setMarket('BINANCE:BTCEUR', {
+      type: 'Range',
+      timeframe: 'D',
+      inputs: {
+        range: 1,
+        phantomBars: false,
+      },
+    });
+  }, 5000);
+
+  /* (6s) Delete chart, close client */
+  setTimeout(async () => {
+    success('Closing client...');
+    chart.delete();
+    await client.end();
+    cb();
+  }, 6000);
+};

package/tests/9. AllErrors.js

@@ -0,0 +1,146 @@
+const TradingView = require('../main');
+
+module.exports = async (log, success, warn, err, cb) => {
+  const client = new TradingView.Client(); // Creates a websocket client
+
+  const tests = [
+    (next) => { /* Testing "Credentials error" */
+      log('Testing "Credentials error" error:');
+
+      const client2 = new TradingView.Client({
+        token: 'FAKE_CREDENTIALS', // Set wrong credentials
+      });
+
+      client2.onError((...error) => {
+        success('=> Client error:', error);
+        client2.end();
+        next();
+      });
+    },
+
+    (next) => { /* Testing "Invalid symbol" */
+      log('Testing "Invalid symbol" error:');
+
+      const chart = new client.Session.Chart();
+      chart.onError((...error) => { // Listen for errors
+        success('=> Chart error:', error);
+        chart.delete();
+        next();
+      });
+
+      chart.setMarket('XXXXX'); // Set a wrong market
+    },
+
+    (next) => { /* Testing "Invalid timezone" */
+      log('Testing "Invalid timezone" error:');
+
+      const chart = new client.Session.Chart();
+      chart.onError((...error) => { // Listen for errors
+        success('=> Chart error:', error);
+        next();
+      });
+
+      chart.setMarket('BINANCE:BTCEUR'); // Set a market
+      chart.setTimezone('Nowhere/Nowhere'); // Set a fake timezone
+    },
+
+    (next) => { /* Testing "Custom timeframe" */
+      log('Testing "Custom timeframe" error:');
+
+      const chart = new client.Session.Chart();
+      chart.onError((...error) => { // Listen for errors
+        success('=> Chart error:', error);
+        chart.delete();
+        next();
+      });
+
+      chart.setMarket('BINANCE:BTCEUR', { // Set a market
+        timeframe: '20', // Set a custom timeframe
+        /*
+          Timeframe '20' isn't available because we are
+          not logged in as a premium TradingView account
+        */
+      });
+    },
+
+    (next) => { /* Testing "Invalid timeframe" */
+      log('Testing "Invalid timeframe" error:');
+
+      const chart = new client.Session.Chart();
+      chart.onError((...error) => { // Listen for errors
+        success('=> Chart error:', error);
+        next();
+      });
+
+      chart.setMarket('BINANCE:BTCEUR', { // Set a market
+        timeframe: 'XX', // Set a wrong timeframe
+      });
+    },
+
+    (next) => { /* Testing "Study not auth" */
+      log('Testing "Study not auth" error:');
+
+      const chart = new client.Session.Chart();
+      chart.onError((...error) => { // Listen for errors
+        success('=> Chart error:', error);
+        next();
+      });
+
+      chart.setMarket('BINANCE:BTCEUR', { // Set a market
+        timeframe: '15',
+        type: 'Renko',
+      });
+
+      chart.onUpdate(() => {
+        log('DATA', chart.periods[0]);
+      });
+    },
+
+    (next) => { /* Testing "Set the market before" */
+      log('Testing "Set the market before..." error:');
+
+      const chart = new client.Session.Chart();
+      chart.onError((...error) => { // Listen for errors
+        success('=> Chart error:', error);
+        chart.delete();
+        next();
+      });
+
+      chart.setSeries('15'); // Set series before setting the market
+    },
+
+    (next) => { /* Testing "Inexistent indicator" */
+      log('Testing "Inexistent indicator" error:');
+
+      TradingView.getIndicator('STD;XXXXXXX')
+        .catch((error) => {
+          success('=> API error:', [error.message]);
+          next();
+        });
+    },
+
+    async (next) => { /* Testing "Invalid value" */
+      log('Testing "Invalid value" error:');
+
+      const chart = new client.Session.Chart();
+      chart.setMarket('BINANCE:BTCEUR'); // Set a market
+
+      const ST = await TradingView.getIndicator('STD;Supertrend');
+      ST.setOption('Factor', -1); // This will cause an error
+
+      const Supertrend = new chart.Study(ST);
+      Supertrend.onError((...error) => {
+        success('=> Study error:', error);
+        chart.delete();
+        next();
+      });
+    },
+  ];
+
+  (async () => {
+    // eslint-disable-next-line no-restricted-syntax, no-await-in-loop
+    for (const t of tests) await new Promise(t);
+    success(`Crashtests ${tests.length}/${tests.length} done !`);
+    cb();
+  })();
+};

package/tests/disabled/x. Template.js

@@ -0,0 +1,24 @@
+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');
+  });
+
+  chart.delete();
+  await client.end();
+  cb();
+};

package/.github/FUNDING.yml

@@ -1 +0,0 @@
-github: Mathieu2301

package/tests/alerts/discordWH.js

@@ -1,76 +0,0 @@
-const https = require('https');
-
-/**
- * @typedef {Object} WebhookMessage Represents a Discord webhook message
- * @property {string} content
- * @property {Embed[]} [embeds]
- */
-
-/**
- * @typedef {Object} Embed Discord Embed
- * @property {string} [title]
- * @property {string} [description]
- * @property {number} [color]
- * @property {string} [url]
- * @property {string} [timestamp]
-
- * @property {Object} [author]
- * @property {string} [author.name]
- * @property {string} [author.icon_url]
- * @property {string} [author.url]
-
- * @property {Object} [thumbnail]
- * @property {string} [thumbnail.url]
-
- * @property {Object} [footer]
- * @property {string} [footer.text]
- * @property {string} [footer.icon_url]
- */
-
-/**
- * @typedef {Object} SendResult
- * @property {boolean} success
- * @property {Object} [result] If error
- * @property {string[]} [result.webhook_id]
- */
-
-/**
- * Create an instance of Discord Webhook API
- * @param {string} token Discord Webhook token (after .../api/webhooks/)
- */
-
-module.exports = function createInstance(token = '') {
-  /**
-   * Send a message
-   * @name MessageSender
-   * @param {WebhookMessage} message
-   * @returns {Promise<SendResult>}
-  */
-  return (message) => new Promise((cb, err) => {
-    const req = https.request({
-      method: 'POST',
-      hostname: 'discordapp.com',
-      path: `/api/webhooks/${token}`,
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      maxRedirects: 20,
-    }, (res) => {
-      let data = '';
-      res.on('data', (d) => { data += d; });
-      res.on('end', () => {
-        if (!data) cb({ success: true });
-        else {
-          cb({
-            success: false,
-            result: JSON.parse(data),
-          });
-        }
-      });
-    });
-
-    req.on('error', err);
-    req.write(JSON.stringify(message));
-    req.end();
-  });
-};

package/tests/alerts/drawings.js

@@ -1,41 +0,0 @@
-require('./envLoader');
-const marketAPI = require('../../main');
-
-if (!process.env.LAYOUT_ID) console.error('You need to set a layout id');
-
-const market = marketAPI(false);
-
-console.log('Connecting...');
-
-(async () => {
-  /*
-  * Important ! If you want to get a layout without login, you have to
-  * set it in public mode. If you get an error, please wait few minutes.
-  * Try getting to https://www.tradingview.com/chart/LAYOUT_ID/ in incognito mode.
-  */
-  const user = (process.env.SESSION_ID) ? await market.getUser(process.env.SESSION_ID) : {};
-  console.log('Connected as', user.firstName || user.username || 'anonymous', '!');
-
-  console.log(`Gettings drawings of '${process.env.LAYOUT_ID}' layout...`);
-
-  const drawings = await market.getDrawings(process.env.LAYOUT_ID, '', {
-    id: user.id,
-    session: user.session,
-  });
-
-  const lines = drawings.filter((d) => (
-    ['LineToolHorzLine', 'LineToolRay', 'LineToolTrendLine', 'LineToolHorzRay'].includes(d.type)
-    && d.state.linestyle === 0
-    && d.state.linewidth === 4
-  ));
-
-  console.log(
-    `Found ${drawings.length} result(s) including ${lines.length} thick line(s):`,
-    lines.map((l) => ({
-      market: l.symbol,
-      type: l.type,
-      points: l.points,
-      text: l.state.text,
-    })),
-  );
-})();

package/tests/alerts/envLoader.js

@@ -1,11 +0,0 @@
-const fs = require('fs');
-
-if (fs.existsSync('.env')) {
-  const envFile = fs.readFileSync('.env', 'utf8');
-  envFile.split('\n') // LF
-    .forEach((l) => {
-      const s = l.split('=');
-      // eslint-disable-next-line
-      if (s[1]) process.env[s[0]] = s[1];
-    });
-}

package/tests/alerts/manualAlert.js

@@ -1,77 +0,0 @@
-require('./envLoader');
-const { getSentNotifs, addSentNotifs } = require('./sentNotifs');
-const marketAPI = require('../../main');
-const discordWH = require('./discordWH')(process.env.DISCORD_TOKEN);
-
-if (!process.env.SYMBOLS) process.env.SYMBOLS = 'BTCEUR';
-if (!process.env.PERIOD) process.env.PERIOD = '240';
-
-const market = marketAPI(false);
-
-market.on('logged', () => {
-  process.env.SYMBOLS.split(',').forEach((symbol) => {
-    console.log('Listen', symbol);
-
-    market.initChart({
-      symbol,
-      period: process.env.PERIOD,
-      range: 30,
-      timezone: 'Europe/Paris',
-      indicators: [
-        { name: 'CIPHER_A', id: 'PUB;vrOJcNRPULteowIsuP6iHn3GIxBJdXwT', version: '1.0' },
-        {
-          name: 'CIPHER_B',
-          id: 'PUB;uA35GeckoTA2EfgI63SD2WCSmca4njxp',
-          settings: [ // Activate Stoch divergences
-            true, true, true, true, true, true, 9, 12,
-            'hlc3', 3, 53, 60, 100, -53, -60, -75, true,
-            true, true, 45, -65, true, 15, -40, true, 60,
-            150, 2.5, false, 'close', 14, 30, 60, false,
-            false, 60, 30, true, true, false, 'close', 14,
-            14, 3, 3, true, true, false, 'close', 10, 23,
-            50, 0.5, false, false, '720', 0, 0, 0, 0, 0, 0,
-            false, '60', '240', 0, 0, false, '240', false,
-          ],
-          version: '15.0',
-        },
-      ],
-    }, (periods) => {
-      if (!periods[0].CIPHER_B) return;
-
-      const pBefore = periods[1];
-      const p = periods[0];
-
-      const gapBefore = pBefore.CIPHER_B.VWAP;
-      const gap = p.CIPHER_B.VWAP;
-
-      const notifID = `${symbol}@${p.$time}@BULL_TRIGGER`;
-
-      if (
-        p.CIPHER_B.WTWave1 <= 0 && p.CIPHER_B.WTWave1 > -35
-        && gapBefore < 0 && gapBefore < gap
-        && pBefore.CIPHER_B.WTWave1 < p.CIPHER_B.WTWave1
-        && !getSentNotifs().includes(notifID)
-      ) {
-        addSentNotifs(notifID);
-        console.log(symbol, 'TRIG NOW', new Date(p.$time * 1000).toLocaleString());
-
-        discordWH({
-          content: process.env.DISCORD_MENTION,
-          embeds: [
-            {
-              title: `Trigger wave on ${symbol} !`,
-              color: 720640,
-              description: `Cipher B trigger wave detected on ${symbol}.`,
-              url: `https://fr.tradingview.com/chart/?symbol=${symbol}`,
-              timestamp: new Date(p.$time * 1000),
-              footer: {
-                text: 'TradingView',
-                icon_url: 'https://tradingview.com/favicon.ico',
-              },
-            },
-          ],
-        });
-      }
-    });
-  });
-});

package/tests/alerts/sentNotifs.js

@@ -1,16 +0,0 @@
-const fs = require('fs');
-
-const sentNotifsFile = './sentNotifs.txt';
-
-exports.getSentNotifs = () => {
-  if (!fs.existsSync(sentNotifsFile)) fs.writeFileSync(sentNotifsFile, '');
-  return (fs.readFileSync(sentNotifsFile, 'utf8') || '').split(';').filter((n) => n);
-};
-
-exports.addSentNotifs = (notif = '') => {
-  if (!fs.existsSync(sentNotifsFile)) fs.writeFileSync(sentNotifsFile, '');
-  fs.writeFileSync(
-    sentNotifsFile,
-    `${fs.readFileSync(sentNotifsFile, 'utf8') || ''}${notif};`,
-  );
-};

package/tests/alerts/strategyAlert.js

@@ -1,94 +0,0 @@
-require('./envLoader');
-const { getSentNotifs, addSentNotifs } = require('./sentNotifs');
-const marketAPI = require('../../main');
-const discordWH = require('./discordWH')(process.env.DISCORD_TOKEN);
-
-const markets = [
-  {
-    symbol: 'EURUSD',
-    period: '1D',
-    settings: {
-      1: 21, // HMA 1 Length
-      3: 89, // HMA 2 Length
-      5: 7, // RSI Length
-      8: 2, // Stop Loss (%)
-      9: 1, // Take Profit (%)
-    },
-  },
-  {
-    symbol: 'GBPUSD',
-    period: '1D',
-    settings: {
-      1: 220, // HMA 1 Length
-      3: 150, // HMA 2 Length
-      5: 1, // RSI Length
-      8: 2, // Stop Loss (%)
-      9: 1, // Take Profit (%)
-    },
-  },
-  {
-    symbol: 'USDCAD',
-    period: '1D',
-    settings: {
-      1: 21, // HMA 1 Length
-      3: 89, // HMA 2 Length
-      5: 10, // RSI Length
-      8: 3, // Stop Loss (%)
-      9: 2, // Take Profit (%)
-    },
-  },
-];
-
-const market = marketAPI(false);
-
-market.on('logged', () => {
-  markets.forEach((mrk) => {
-    console.log('Listen', mrk.symbol);
-
-    market.initChart({
-      symbol: mrk.symbol,
-      period: mrk.period || '1D',
-      range: mrk.range || 30,
-      timezone: mrk.timezone || 'Europe/Paris',
-      indicators: [
-        // My Magimix Indicator
-        {
-          name: 'MAGIMIX',
-          id: 'USER;d90a5e852ddc439b994db6beff14d702',
-          version: mrk.version || 'last',
-          settings: mrk.settings || [],
-        },
-      ],
-    }, ({ 0: p }) => {
-      if (!p.MAGIMIX) return;
-
-      const signalType = p.MAGIMIX.Longsignal ? 'LONG' : 'SHORT';
-      const notifID = `${mrk.symbol}@MAGIMIX@${p.$time}@${signalType}`;
-
-      if (
-        (p.MAGIMIX.Longsignal || p.MAGIMIX.Shortsignal)
-        && !getSentNotifs().includes(notifID)
-      ) {
-        addSentNotifs(notifID);
-        console.log(mrk.symbol, 'SIGNAL', new Date(p.$time * 1000).toLocaleString());
-
-        discordWH({
-          content: process.env.DISCORD_MENTION,
-          embeds: [
-            {
-              title: `Magimix ${signalType} signal for ${mrk.symbol} !`,
-              color: p.MAGIMIX.Longsignal ? 3066993 : 15158332,
-              description: `Magimix ${signalType} signal for ${mrk.symbol} at ${p.$prices.close} !`,
-              url: `https://fr.tradingview.com/chart/?symbol=${mrk.symbol}`,
-              timestamp: new Date(p.$time * 1000),
-              footer: {
-                text: 'TradingView',
-                icon_url: 'https://tradingview.com/favicon.ico',
-              },
-            },
-          ],
-        });
-      }
-    });
-  });
-});

package/tests/analysis.js

@@ -1,13 +0,0 @@
-const marketAPI = require('../main');
-
-(async () => {
-  const market = marketAPI(false);
-
-  const searchBTC = (await market.search('bitcoin euro', 'crypto'))[0];
-  console.log('Found Bitcoin / Euro:', searchBTC);
-
-  const TA = await searchBTC.getTA();
-  console.log('Full technical analysis for Bitcoin:', TA);
-
-  // You can also use this way: await market.getTA('crypto', 'BINANCE:BTCEUR');
-})();

package/tests/indicator.js

@@ -1,42 +0,0 @@
-const marketAPI = require('../main');
-
-const market = marketAPI(false);
-
-market.on('logged', () => {
-  market.initChart({
-    symbol: 'COINBASE:BTCEUR',
-    period: '240',
-    range: 50,
-    indicators: [
-      { name: 'ACCU_DISTRIB', id: 'STD;Accumulation_Distribution', version: '25' },
-      { name: 'CIPHER_A', id: 'PUB;vrOJcNRPULteowIsuP6iHn3GIxBJdXwT', version: '1.0' },
-      {
-        name: 'CIPHER_B',
-        id: 'PUB;uA35GeckoTA2EfgI63SD2WCSmca4njxp',
-        settings: [ // Activate Stoch divergences
-          true, true, true, true, true, true, 9, 12,
-          'hlc3', 3, 53, 60, 100, -53, -60, -75, true,
-          true, true, 45, -65, true, 15, -40, true, 60,
-          150, 2.5, false, 'close', 14, 30, 60, false,
-          false, 60, 30, true, true, false, 'close', 14,
-          14, 3, 3, true, true, false, 'close', 10, 23,
-          50, 0.5, false, false, '720', 0, 0, 0, 0, 0, 0,
-          false, '60', '240', 0, 0, false, '240', false,
-        ],
-        version: '15.0',
-      },
-      // Color Changing Moving Average
-      { name: 'CCMA', id: 'PUB;5nawr3gCESvSHQfOhrLPqQqT4zM23w3X', version: '6.0' },
-    ],
-  }, (periods) => {
-    if (!periods[0].CIPHER_B) return;
-    if (!periods[0].CCMA) return;
-
-    console.log('Last period:', {
-      price: periods[0].$prices.close,
-      moneyFlow: (periods[0].CIPHER_B.RSIMFIArea >= 0) ? 'POSITIVE' : 'NEGATIVE',
-      VWAP: periods[0].CIPHER_B.VWAP,
-      MA: (periods[0].CCMA.Plot <= periods[0].$prices.close) ? 'ABOVE' : 'UNDER',
-    });
-  });
-});