@mathieuc/tradingview 3.0.1 → 3.3.1

package/src/classes/PinePermManager.js

@@ -0,0 +1,143 @@
+const request = require('../request');
+const FormData = require('../FormData');
+
+/**
+ * @typedef {Object} AuthorizationUser
+ * @prop {id} id User id
+ * @prop {string} username User's username
+ * @prop {string} userpic User's profile picture URL
+ * @prop {string} expiration Authorization expiration date
+ * @prop {string} created Authorization creation date
+ */
+
+/** @class */
+class PinePermManager {
+  sessionId;
+
+  pineId;
+
+  /**
+   * Creates a PinePermManager instance
+   * @param {string} sessionId Token from sessionid cookie
+   * @param {string} pineId Indicator ID (Like: PUB;XXXXXXXXXXXXXXXXXXXXX)
+   */
+  constructor(sessionId, pineId) {
+    if (!sessionId) throw new Error('Please provide a SessionID');
+    if (!pineId) throw new Error('Please provide a PineID');
+    this.pineId = pineId;
+    this.sessionId = sessionId;
+  }
+
+  /**
+   * Get list of authorized users
+   * @param {number} limit Fetching limit
+   * @param {'user__username'
+   * | '-user__username'
+   * | 'created' | 'created'
+   * | 'expiration,user__username'
+   * | '-expiration,user__username'
+   * } order Fetching order
+   * @returns {AuthorizationUser[]}
+   */
+  async getUsers(limit = 10, order = '-created') {
+    const { data } = await request({
+      method: 'POST',
+      host: 'www.tradingview.com',
+      path: `/pine_perm/list_users/?limit=${limit}&order_by=${order}`,
+      headers: {
+        origin: 'https://www.tradingview.com',
+        'Content-Type': 'application/x-www-form-urlencoded',
+        cookie: `sessionid=${this.sessionId}`,
+      },
+    }, false, `pine_id=${this.pineId.replace(/;/g, '%3B')}`);
+
+    if (!data.results) throw new Error('Wrong sessionId or pineId');
+
+    return data.results;
+  }
+
+  /**
+   * Adds an user to the authorized list
+   * @param {string} username User's username
+   * @param {Date} [expiration] Expiration date
+   * @returns {'ok' | 'exists' | null}
+   */
+  async addUser(username, expiration = null) {
+    const formData = new FormData();
+    formData.append('pine_id', this.pineId);
+    formData.append('username_recip', username);
+    if (expiration && expiration instanceof Date) {
+      formData.append('expiration', expiration.toString());
+    }
+
+    const { data } = await request({
+      method: 'POST',
+      host: 'www.tradingview.com',
+      path: '/pine_perm/add/',
+      headers: {
+        origin: 'https://www.tradingview.com',
+        'Content-Type': `multipart/form-data; boundary=${formData.boundary}`,
+        cookie: `sessionid=${this.sessionId}`,
+      },
+    }, false, formData.toString());
+
+    if (!data.status) throw new Error('Wrong sessionId or pineId');
+    return data.status;
+  }
+
+  /**
+   * Modify an authorization expiration date
+   * @param {string} username User's username
+   * @param {Date} [expiration] New expiration date
+   * @returns {'ok' | null}
+   */
+  async modifyExpiration(username, expiration = null) {
+    const formData = new FormData();
+    formData.append('pine_id', this.pineId);
+    formData.append('username_recip', username);
+    if (expiration && expiration instanceof Date) {
+      formData.append('expiration', expiration.toISOString());
+    }
+
+    const { data } = await request({
+      method: 'POST',
+      host: 'www.tradingview.com',
+      path: '/pine_perm/modify_user_expiration/',
+      headers: {
+        origin: 'https://www.tradingview.com',
+        'Content-Type': `multipart/form-data; boundary=${formData.boundary}`,
+        cookie: `sessionid=${this.sessionId}`,
+      },
+    }, false, formData.toString());
+
+    if (!data.status) throw new Error('Wrong sessionId or pineId');
+    return data.status;
+  }
+
+  /**
+   * Removes an user to the authorized list
+   * @param {string} username User's username
+   * @returns {'ok' | null}
+   */
+  async removeUser(username) {
+    const formData = new FormData();
+    formData.append('pine_id', this.pineId);
+    formData.append('username_recip', username);
+
+    const { data } = await request({
+      method: 'POST',
+      host: 'www.tradingview.com',
+      path: '/pine_perm/remove/',
+      headers: {
+        origin: 'https://www.tradingview.com',
+        'Content-Type': `multipart/form-data; boundary=${formData.boundary}`,
+        cookie: `sessionid=${this.sessionId}`,
+      },
+    }, false, formData.toString());
+
+    if (!data.status) throw new Error('Wrong sessionId or pineId');
+    return data.status;
+  }
+}
+
+module.exports = PinePermManager;

package/src/client.js

@@ -15,9 +15,10 @@ const chartSessionGenerator = require('./chart/session');
 /** @typedef {Object<string, Session>} SessionList Session list */
 
 /**
- * @typedef {(t: string, p: []) => null} SendPacket Send a custom packet
+ * @callback SendPacket Send a custom packet
  * @param {string} t Packet type
  * @param {string[]} p Packet data
+ * @returns {void}
 */
 
 /**
@@ -33,6 +34,7 @@ const chartSessionGenerator = require('./chart/session');
  * } ClientEvent
  */
 
+/** @class */
 module.exports = class Client {
   #ws;
 
@@ -79,7 +81,7 @@ module.exports = class Client {
   /**
    * When client is connected
    * @param {() => void} cb Callback
-   * @event
+   * @event onConnected
    */
   onConnected(cb) {
     this.#callbacks.connected.push(cb);
@@ -88,7 +90,7 @@ module.exports = class Client {
   /**
    * When client is disconnected
    * @param {() => void} cb Callback
-   * @event
+   * @event onDisconnected
    */
   onDisconnected(cb) {
     this.#callbacks.disconnected.push(cb);
@@ -105,10 +107,12 @@ module.exports = class Client {
    * @prop {string} javastudies Javastudies
    * @prop {number} auth_scheme_vsn Auth scheme type
    * @prop {string} via Socket IP
+   */
 
+  /**
    * When client is logged
    * @param {(SocketSession: SocketSession) => void} cb Callback
-   * @event
+   * @event onLogged
    */
   onLogged(cb) {
     this.#callbacks.logged.push(cb);
@@ -117,7 +121,7 @@ module.exports = class Client {
   /**
    * When server is pinging the client
    * @param {(i: number) => void} cb Callback
-   * @event
+   * @event onPing
    */
   onPing(cb) {
     this.#callbacks.ping.push(cb);
@@ -126,7 +130,7 @@ module.exports = class Client {
   /**
    * When unparsed data is received
    * @param {(...{}) => void} cb Callback
-   * @event
+   * @event onData
    */
   onData(cb) {
     this.#callbacks.data.push(cb);
@@ -135,7 +139,7 @@ module.exports = class Client {
   /**
    * When a client error happens
    * @param {(...{}) => void} cb Callback
-   * @event
+   * @event onError
    */
   onError(cb) {
     this.#callbacks.error.push(cb);
@@ -144,7 +148,7 @@ module.exports = class Client {
   /**
    * When a client event happens
    * @param {(...{}) => void} cb Callback
-   * @event
+   * @event onEvent
    */
   onEvent(cb) {
     this.#callbacks.event.push(cb);
@@ -203,6 +207,7 @@ module.exports = class Client {
     while (this.isOpen && this.#logged && this.#sendQueue.length > 0) {
       const packet = this.#sendQueue.shift();
       this.#ws.send(packet);
+      if (global.TW_DEBUG) console.log('§90§30§107 > §0', packet);
     }
   }
 
@@ -210,6 +215,7 @@ module.exports = class Client {
    * @typedef {Object} ClientOptions
    * @prop {string} [token] User auth token (in 'sessionid' cookie)
    * @prop {boolean} [DEBUG] Enable debug mode
+   * @prop {'data' | 'prodata' | 'widgetdata'} [server] Server type
    */
 
   /** Client object
@@ -218,7 +224,8 @@ module.exports = class Client {
   constructor(clientOptions = {}) {
     if (clientOptions.DEBUG) global.TW_DEBUG = clientOptions.DEBUG;
 
-    this.#ws = new WebSocket('wss://widgetdata.tradingview.com/socket.io/websocket', {
+    const server = clientOptions.server || 'data';
+    this.#ws = new WebSocket(`wss://${server}.tradingview.com/socket.io/websocket`, {
       origin: 'https://s.tradingview.com',
     });
 
@@ -273,7 +280,7 @@ module.exports = class Client {
    */
   end() {
     return new Promise((cb) => {
-      this.#ws.close();
+      if (this.#ws.readyState) this.#ws.close();
       cb();
     });
   }

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);
@@ -287,10 +275,12 @@ module.exports = {
     data.result.metaInfo.inputs.forEach((input) => {
       if (['text', 'pineId', 'pineVersion'].includes(input.id)) return;
 
+      const inlineName = input.name.replace(/ /g, '_').replace(/[^a-zA-Z0-9_]/g, '');
+
       inputs[input.id] = {
         name: input.name,
-        inline: input.inline || input.name.replace(/ /g, '_').replace(/[^a-zA-Z0-9_]/g, ''),
-        internalID: input.internalID,
+        inline: input.inline || inlineName,
+        internalID: input.internalID || inlineName,
         tooltip: input.tooltip,
 
         type: input.type,
@@ -340,25 +330,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 a token for an user from a 'sessionid' cookie
+   * 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 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 +443,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 +477,9 @@ module.exports = {
             get() {
               return module.exports.getIndicator(ind.scriptIdPart, ind.version);
             },
+            getManager() {
+              return new PinePermManager(ind.scriptIdPart);
+            },
           })));
         });
 
@@ -448,12 +491,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 +507,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 +520,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 +554,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}` : ''}`,