@mathieuc/tradingview 3.0.0 → 3.3.0

package/src/miscRequests.js

@@ -1,45 +1,16 @@
+const os = require('os');
 const https = require('https');
+const request = require('./request');
+const FormData = require('./FormData');
 
+const PinePermManager = require('./classes/PinePermManager');
 const PineIndicator = require('./classes/PineIndicator');
 
 const indicators = ['Recommend.Other', 'Recommend.All', 'Recommend.MA'];
 const builtInIndicList = [];
 
-/**
- * @param {https.RequestOptions} options HTTPS Request options
- * @param {boolean} [raw] Get raw or JSON data
- * @param {string} [content] Request body content
- * @returns {Promise<string | object | array>} 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);
-          return;
-        }
-
-        try {
-          data = JSON.parse(data);
-        } catch (error) {
-          err(new Error('Can\'t parse server response'));
-          return;
-        }
-
-        cb(data);
-      });
-    });
-
-    req.on('error', err);
-    req.end(content);
-  });
-}
-
 async function fetchScanData(tickers = [], type = '', columns = []) {
-  let data = await request({
+  let { data } = await request({
     method: 'POST',
     hostname: 'scanner.tradingview.com',
     path: `/${type}/scan`,
@@ -59,11 +30,17 @@ async function fetchScanData(tickers = [], type = '', columns = []) {
   return data;
 }
 
+/** @typedef {number} advice */
+
+/**
+ * @typedef {{
+ *   Other: advice,
+ *   All: advice,
+ *   MA: advice
+ * }} Period
+ */
+
 /**
- * @typedef {number} advice
- *
- * @typedef {{ Other: advice, All: advice, MA: advice }} Period
- *
  * @typedef {{
  *  '1': Period,
  *  '5': Period,
@@ -72,21 +49,25 @@ async function fetchScanData(tickers = [], type = '', columns = []) {
  *  '240': Period,
  *  '1D': Period,
  *  '1W': Period,
- *  '1M': Period,
+ *  '1M': Period
  * }} Periods
- *
+ */
+
+/**
  * @typedef {string | 'forex' | 'crypto'
  * | 'america' | 'australia' | 'canada' | 'egypt'
  * | 'germany' | 'india' | 'israel' | 'italy'
  * | 'luxembourg' | 'poland' | 'sweden' | 'turkey'
- * | 'uk' | 'vietnam'} screener
+ * | 'uk' | 'vietnam'} Screener
  * You can use `getScreener(exchange)` function for non-forex and non-crypto markets.
  */
 
 module.exports = {
   /**
+   * Get a screener from an exchange
+   * @function getScreener
    * @param {string} exchange Example: BINANCE, EURONEXT, NASDAQ
-   * @returns {screener}
+   * @returns {Screener}
   */
   getScreener(exchange) {
     const e = exchange.toUpperCase();
@@ -109,7 +90,8 @@ module.exports = {
 
   /**
    * Get technical analysis
-   * @param {screener} screener
+   * @function getTA
+   * @param {Screener} screener Market screener
    * @param {string} id Full market id (Example: COINBASE:BTCEUR)
    * @returns {Promise<Periods>} results
    */
@@ -135,24 +117,28 @@ module.exports = {
 
   /**
    * @typedef {Object} SearchMarketResult
-   * @property {string} id
-   * @property {string} exchange
-   * @property {string} fullExchange
-   * @property {string} screener
-   * @property {string} symbol
-   * @property {string} description
-   * @property {string} type
-   * @property {() => Promise<Periods>} getTA
+   * @prop {string} id Market full symbol
+   * @prop {string} exchange Market exchange name
+   * @prop {string} fullExchange Market exchange full name
+   * @prop {Screener | 'forex' | 'crypto'} screener Market screener
+   * @prop {string} symbol Market symbol
+   * @prop {string} description Market name
+   * @prop {string} type Market type
+   * @prop {() => Promise<Periods>} getTA Get market technical analysis
    */
 
   /**
    * Find a symbol
+   * @function searchMarket
    * @param {string} search Keywords
-   * @param {'stock' | 'futures' | 'forex' | 'cfd' | 'crypto' | 'index' | 'economic'} [filter]
+   * @param {'stock'
+   *  | 'futures' | 'forex' | 'cfd'
+   *  | 'crypto' | 'index' | 'economic'
+   * } [filter] Caterogy filter
    * @returns {Promise<SearchMarketResult[]>} Search results
    */
   async searchMarket(search, filter = '') {
-    const data = await request({
+    const { data } = await request({
       host: 'symbol-search.tradingview.com',
       path: `/symbol_search/?text=${search.replace(/ /g, '%20')}&type=${filter}`,
       origin: 'https://www.tradingview.com',
@@ -182,34 +168,35 @@ module.exports = {
 
   /**
    * @typedef {Object} SearchIndicatorResult
-   * @property {string} id Script ID
-   * @property {string} version Script version
-   * @property {string} name Script complete name
-   * @property {{ id: number, username: string }} author Author user ID
-   * @property {string} image Image ID https://tradingview.com/i/${image}
-   * @property {string | ''} source Script source (if available)
-   * @property {'study' | 'strategy'} type Script type (study / strategy)
-   * @property {'open_source' | 'closed_source' | 'invite_only'
+   * @prop {string} id Script ID
+   * @prop {string} version Script version
+   * @prop {string} name Script complete name
+   * @prop {{ id: number, username: string }} author Author user ID
+   * @prop {string} image Image ID https://tradingview.com/i/${image}
+   * @prop {string | ''} source Script source (if available)
+   * @prop {'study' | 'strategy'} type Script type (study / strategy)
+   * @prop {'open_source' | 'closed_source' | 'invite_only'
    *  | 'private' | 'other'} access Script access type
-   * @property {() => Promise<PineIndicator>} get Get the full indicator informations
+   * @prop {() => Promise<PineIndicator>} get Get the full indicator informations
    */
 
   /**
    * Find an indicator
+   * @function searchIndicator
    * @param {string} search Keywords
    * @returns {Promise<SearchIndicatorResult[]>} Search results
    */
   async searchIndicator(search = '') {
     if (!builtInIndicList.length) {
       await Promise.all(['standard', 'candlestick', 'fundamental'].map(async (type) => {
-        builtInIndicList.push(...await request({
+        builtInIndicList.push(...(await request({
           host: 'pine-facade.tradingview.com',
           path: `/pine-facade/list/?filter=${type}`,
-        }));
+        })).data);
       }));
     }
 
-    const data = await request({
+    const { data } = await request({
       host: 'www.tradingview.com',
       path: `/pubscripts-suggest-json/?search=${search.replace(/ /g, '%20')}`,
     });
@@ -260,6 +247,7 @@ module.exports = {
 
   /**
    * Get an indicator
+   * @function getIndicator
    * @param {string} id Indicator ID (Like: PUB;XXXXXXXXXXXXXXXXXXXXX)
    * @param {'last' | string} [version] Wanted version of the indicator
    * @returns {Promise<PineIndicator>} Indicator
@@ -267,7 +255,7 @@ module.exports = {
   async getIndicator(id, version = 'last') {
     const indicID = id.replace(/ |%/g, '%25');
 
-    let data = await request({
+    let { data } = await request({
       host: 'pine-facade.tradingview.com',
       path: `/pine-facade/translate/${indicID}/${version}`,
     }, true);
@@ -340,25 +328,74 @@ module.exports = {
 
   /**
    * @typedef {Object} User Instance of User
-   * @property {number} id User ID
-   * @property {string} username User username
-   * @property {string} firstName User first name
-   * @property {string} lastName User last name
-   * @property {number} reputation User reputation
-   * @property {number} following Number of following accounts
-   * @property {number} followers Number of followers
-   * @property {Object} notifications User's notifications
-   * @property {number} notifications.user User notifications
-   * @property {number} notifications.following Notification from following accounts
-   * @property {string} session User session
-   * @property {string} sessionHash User session hash
-   * @property {string} privateChannel User private channel
-   * @property {string} authToken User auth token
-   * @property {Date} joinDate Account creation date
+   * @prop {number} id User ID
+   * @prop {string} username User username
+   * @prop {string} firstName User first name
+   * @prop {string} lastName User last name
+   * @prop {number} reputation User reputation
+   * @prop {number} following Number of following accounts
+   * @prop {number} followers Number of followers
+   * @prop {Object} notifications User's notifications
+   * @prop {number} notifications.user User notifications
+   * @prop {number} notifications.following Notification from following accounts
+   * @prop {string} session User session
+   * @prop {string} sessionHash User session hash
+   * @prop {string} privateChannel User private channel
+   * @prop {string} authToken User auth token
+   * @prop {Date} joinDate Account creation date
+   */
+
+  /**
+   * Get user and sessionid from username/email and password
+   * @function loginUser
+   * @param {string} username User username/email
+   * @param {string} password User password
+   * @param {boolean} [remember] Remember the session (default: false)
+   * @param {string} [UA] Custom UserAgent
+   * @returns {Promise<User>} Token
    */
+  async loginUser(username, password, remember = true, UA = 'TWAPI/3.0') {
+    const formData = new FormData();
+    formData.append('username', username);
+    formData.append('password', password);
+    if (remember) formData.append('remember', 'on');
+
+    const { data, cookies } = await request({
+      method: 'POST',
+      host: 'www.tradingview.com',
+      path: '/accounts/signin/',
+      headers: {
+        referer: 'https://www.tradingview.com',
+        'Content-Type': `multipart/form-data; boundary=${formData.boundary}`,
+        'User-agent': `${UA} (${os.version()}; ${os.platform()}; ${os.arch()})`,
+      },
+    }, false, formData.toString());
+
+    if (data.error) throw new Error(data.error);
+
+    const cookie = cookies.find((c) => c.includes('sessionid='));
+    const session = (cookie.match(/sessionid=(.*?);/) ?? [])[1];
+
+    return {
+      id: data.user.id,
+      username: data.user.username,
+      firstName: data.user.first_name,
+      lastName: data.user.last_name,
+      reputation: data.user.reputation,
+      following: data.user.following,
+      followers: data.user.followers,
+      notifications: data.user.notification_count,
+      session,
+      sessionHash: data.user.session_hash,
+      privateChannel: data.user.private_channel,
+      authToken: data.user.auth_token,
+      joinDate: new Date(data.user.date_joined),
+    };
+  },
 
   /**
-   * Get a token for an user from a 'sessionid' cookie
+   * Get user from 'sessionid' cookie
+   * @function getUser
    * @param {string} session User 'sessionid' cookie
    * @param {string} [location] Auth page location (For france: https://fr.tradingview.com/)
    * @returns {Promise<User>} Token
@@ -404,6 +441,7 @@ module.exports = {
 
   /**
    * Get user's private indicators from a 'sessionid' cookie
+   * @function getPrivateIndicators
    * @param {string} session User 'sessionid' cookie
    * @returns {Promise<SearchIndicatorResult[]>} Search results
    */
@@ -437,6 +475,9 @@ module.exports = {
             get() {
               return module.exports.getIndicator(ind.scriptIdPart, ind.version);
             },
+            getManager() {
+              return new PinePermManager(ind.scriptIdPart);
+            },
           })));
         });
 
@@ -448,12 +489,13 @@ module.exports = {
   /**
    * User credentials
    * @typedef {Object} UserCredentials
-   * @property {number} id User ID
-   * @property {string} session User session ('sessionid' cookie)
+   * @prop {number} id User ID
+   * @prop {string} session User session ('sessionid' cookie)
    */
 
   /**
    * Get a chart token from a layout ID and the user credentials if the layout is not public
+   * @function getChartToken
    * @param {string} layout The layout ID found in the layout URL (Like: 'XXXXXXXX')
    * @param {UserCredentials} [credentials] User credentials (id + session)
    * @returns {Promise<string>} Token
@@ -463,7 +505,7 @@ module.exports = {
     const userID = creds ? credentials.id : -1;
     const session = creds ? credentials.session : null;
 
-    const data = await request({
+    const { data } = await request({
       host: 'www.tradingview.com',
       path: `/chart-token/?image_url=${layout}&user_id=${userID}`,
       headers: { cookie: session ? `sessionid=${session}` : '' },
@@ -476,32 +518,33 @@ module.exports = {
 
   /**
    * @typedef {Object} DrawingPoint Drawing poitn
-   * @property {number} time_t Point X time position
-   * @property {number} price Point Y price position
-   * @property {number} offset Point offset
+   * @prop {number} time_t Point X time position
+   * @prop {number} price Point Y price position
+   * @prop {number} offset Point offset
    */
 
   /**
    * @typedef {Object} Drawing
-   * @property {string} id Drawing ID (Like: 'XXXXXX')
-   * @property {string} symbol Layout market symbol (Like: 'BINANCE:BUCEUR')
-   * @property {string} ownerSource Owner user ID (Like: 'XXXXXX')
-   * @property {string} serverUpdateTime Drawing last update timestamp
-   * @property {string} currencyId Currency ID (Like: 'EUR')
-   * @property {any} unitId Unit ID
-   * @property {string} type Drawing type
-   * @property {DrawingPoint[]} points List of drawing points
-   * @property {number} zorder Drawing Z order
-   * @property {string} linkKey Drawing link key
-   * @property {Object} state Drawing state
+   * @prop {string} id Drawing ID (Like: 'XXXXXX')
+   * @prop {string} symbol Layout market symbol (Like: 'BINANCE:BUCEUR')
+   * @prop {string} ownerSource Owner user ID (Like: 'XXXXXX')
+   * @prop {string} serverUpdateTime Drawing last update timestamp
+   * @prop {string} currencyId Currency ID (Like: 'EUR')
+   * @prop {any} unitId Unit ID
+   * @prop {string} type Drawing type
+   * @prop {DrawingPoint[]} points List of drawing points
+   * @prop {number} zorder Drawing Z order
+   * @prop {string} linkKey Drawing link key
+   * @prop {Object} state Drawing state
    */
 
   /**
    * Get a chart token from a layout ID and the user credentials if the layout is not public
+   * @function getDrawings
    * @param {string} layout The layout ID found in the layout URL (Like: 'XXXXXXXX')
    * @param {string | ''} [symbol] Market filter (Like: 'BINANCE:BTCEUR')
    * @param {UserCredentials} [credentials] User credentials (id + session)
-   * @param {number} [chartID = 1] Chart ID
+   * @param {number} [chartID] Chart ID
    * @returns {Promise<Drawing[]>} Drawings
    */
   async getDrawings(layout, symbol = '', credentials = {}, chartID = 1) {
@@ -509,7 +552,7 @@ module.exports = {
     const creds = credentials.id && credentials.session;
     const session = creds ? credentials.session : null;
 
-    const data = await request({
+    const { data } = await request({
       host: 'charts-storage.tradingview.com',
       path: `/charts-storage/layout/${layout}/sources?chart_id=${chartID
       }&jwt=${chartToken}${symbol ? `&symbol=${symbol}` : ''}`,

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';