@mathieuc/tradingview 2.0.7 → 3.0.0

package/src/quote/session.js

@@ -0,0 +1,124 @@
+const { genSessionID } = require('../utils');
+
+const quoteMarketConstructor = require('./market');
+
+/** @typedef {Object<string, Function[]>} SymbolListeners */
+
+/**
+ * @typedef {Object} QuoteSessionBridge
+ * @prop {string} sessionID
+ * @prop {SymbolListeners} symbolListeners
+ * @prop {import('../client').SendPacket} send
+*/
+
+/**
+ * @typedef {'base-currency-logoid'
+ * | 'ch' | 'chp' | 'currency-logoid' | 'provider_id'
+ * | 'currency_code' | 'current_session' | 'description'
+ * | 'exchange' | 'format' | 'fractional' | 'is_tradable'
+ * | 'language' | 'local_description' | 'logoid' | 'lp'
+ * | 'lp_time' | 'minmov' | 'minmove2' | 'original_name'
+ * | 'pricescale' | 'pro_name' | 'short_name' | 'type'
+ * | 'update_mode' | 'volume' | 'ask' | 'bid' | 'fundamentals'
+ * | 'high_price' | 'low_price' | 'open_price' | 'prev_close_price'
+ * | 'rch' | 'rchp' | 'rtc' | 'rtc_time' | 'status' | 'industry'
+ * | 'basic_eps_net_income' | 'beta_1_year' | 'market_cap_basic'
+ * | 'earnings_per_share_basic_ttm' | 'price_earnings_ttm'
+ * | 'sector' | 'dividends_yield' | 'timezone' | 'country_code'
+ * } quoteField Quote data field
+ */
+
+/** @param {'all' | 'price'} fieldsType */
+function getQuoteFields(fieldsType) {
+  if (fieldsType === 'price') {
+    return ['lp'];
+  }
+
+  return [
+    'base-currency-logoid', 'ch', 'chp', 'currency-logoid',
+    'currency_code', 'current_session', 'description',
+    'exchange', 'format', 'fractional', 'is_tradable',
+    'language', 'local_description', 'logoid', 'lp',
+    'lp_time', 'minmov', 'minmove2', 'original_name',
+    'pricescale', 'pro_name', 'short_name', 'type',
+    'update_mode', 'volume', 'ask', 'bid', 'fundamentals',
+    'high_price', 'low_price', 'open_price', 'prev_close_price',
+    'rch', 'rchp', 'rtc', 'rtc_time', 'status', 'industry',
+    'basic_eps_net_income', 'beta_1_year', 'market_cap_basic',
+    'earnings_per_share_basic_ttm', 'price_earnings_ttm',
+    'sector', 'dividends_yield', 'timezone', 'country_code',
+    'provider_id',
+  ];
+}
+
+/**
+ * @param {import('../client').ClientBridge} client
+ */
+module.exports = (client) => class QuoteSession {
+  #sessionID = genSessionID('qs');
+
+  /** Parent client */
+  #client = client;
+
+  /** @type {SymbolListeners} */
+  #symbolListeners = {};
+
+  /**
+   * @typedef {Object} quoteSessionOptions Quote Session options
+   * @prop {'all' | 'price'} [fields] Asked quote fields
+   * @prop {quoteField[]} [customFields] List of asked quote fields
+   */
+
+  /**
+   * @param {quoteSessionOptions} options Quote settings options
+   */
+  constructor(options = {}) {
+    this.#client.sessions[this.#sessionID] = {
+      type: 'quote',
+      onData: (packet) => {
+        if (global.TW_DEBUG) console.log('§90§30§102 QUOTE SESSION §0 DATA', packet);
+
+        if (packet.type === 'quote_completed') {
+          const symbol = packet.data[1];
+          if (!this.#symbolListeners[symbol]) {
+            this.#client.send('quote_remove_symbols', [this.#sessionID, symbol]);
+            return;
+          }
+          this.#symbolListeners[symbol].forEach((h) => h(packet));
+        }
+
+        if (packet.type === 'qsd') {
+          const symbol = packet.data[1].n;
+          if (!this.#symbolListeners[symbol]) {
+            this.#client.send('quote_remove_symbols', [this.#sessionID, symbol]);
+            return;
+          }
+          this.#symbolListeners[symbol].forEach((h) => h(packet));
+        }
+      },
+    };
+
+    const fields = (options.customFields && options.customFields.length > 0
+      ? options.customFields
+      : getQuoteFields(options.fields)
+    );
+
+    this.#client.send('quote_create_session', [this.#sessionID]);
+    this.#client.send('quote_set_fields', [this.#sessionID, ...fields]);
+  }
+
+  /** @type {QuoteSessionBridge} */
+  #quoteSession = {
+    sessionID: this.#sessionID,
+    symbolListeners: this.#symbolListeners,
+    send: (t, p) => this.#client.send(t, p),
+  };
+
+  /** @constructor */
+  Market = quoteMarketConstructor(this.#quoteSession);
+
+  /** Delete the quote session */
+  delete() {
+    this.#client.send('quote_delete_session', [this.#sessionID]);
+  }
+};

package/src/types.js

@@ -0,0 +1,32 @@
+/**
+ * @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'
+ * | 'America/El_Salvador' | 'America/Bogota' | 'America/Chicago'
+ * | 'America/Lima' | 'America/Mexico_City' | 'America/Caracas'
+ * | 'America/New_York' | 'America/Toronto' | 'America/Argentina/Buenos_Aires'
+ * | 'America/Santiago' | 'America/Sao_Paulo' | 'Atlantic/Reykjavik'
+ * | 'Europe/Dublin' | 'Africa/Lagos' | 'Europe/Lisbon' | 'Europe/London'
+ * | 'Europe/Amsterdam' | 'Europe/Belgrade' | 'Europe/Berlin'
+ * | 'Europe/Brussels' | 'Europe/Copenhagen' | 'Africa/Johannesburg'
+ * | 'Africa/Cairo' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta'
+ * | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Rome' | 'Europe/Stockholm'
+ * | 'Europe/Warsaw' | 'Europe/Zurich' | 'Europe/Athens' | 'Asia/Bahrain'
+ * | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Asia/Jerusalem' | 'Asia/Kuwait'
+ * | 'Europe/Moscow' | 'Asia/Qatar' | 'Europe/Riga' | 'Asia/Riyadh'
+ * | 'Europe/Tallinn' | 'Europe/Vilnius' | 'Asia/Tehran' | 'Asia/Dubai'
+ * | 'Asia/Muscat' | 'Asia/Ashkhabad' | 'Asia/Kolkata' | 'Asia/Almaty'
+ * | 'Asia/Bangkok' | 'Asia/Jakarta' | 'Asia/Ho_Chi_Minh' | 'Asia/Chongqing'
+ * | 'Asia/Hong_Kong' | 'Australia/Perth' | 'Asia/Shanghai' | 'Asia/Singapore'
+ * | '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
+ */
+
+module.exports = {};

package/src/utils.js

@@ -0,0 +1,8 @@
+module.exports = {
+  genSessionID(type = 'xs') {
+    let r = '';
+    const c = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    for (let i = 0; i < 12; i += 1) r += c.charAt(Math.floor(Math.random() * c.length));
+    return `${type}_${r}`;
+  },
+};

package/test.js

@@ -0,0 +1,155 @@
+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...
+  });
+});
+
+// setTimeout(() => {
+//   log('Set timeframe to 240...');
+//   chart.setSeries('240');
+// }, 5000);
+
+// setInterval(() => {
+//   log('Fetch 100 more periods...');
+//   chart.fetchMore(100);
+// }, 10000);

package/tests/alerts/discordWH.js

@@ -1,76 +1,76 @@
-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();
-  });
-};
+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 +1,41 @@
-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,
-    })),
-  );
-})();
+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 +1,11 @@
-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];
-    });
-}
+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];
+    });
+}