@mathieuc/tradingview 3.0.0 → 3.3.0

package/src/chart/study.js

@@ -16,11 +16,11 @@ function getInputs(options) {
     if (options.pineId) pineInputs.pineId = options.pineId;
     if (options.pineVersion) pineInputs.pineVersion = options.pineVersion;
 
-    Object.keys(options.inputs).forEach((inputID) => {
+    Object.keys(options.inputs).forEach((inputID, n) => {
       const input = options.inputs[inputID];
 
       pineInputs[inputID] = {
-        v: input.value,
+        v: (input.type !== 'color') ? input.value : n,
         f: input.isFake,
         t: input.type,
       };
@@ -35,80 +35,80 @@ function getInputs(options) {
 /**
  * @typedef {Object} TradeReport Trade report
 
- * @property {Object} entry Trade entry
- * @property {string} entry.name Trade name
- * @property {'long' | 'short'} entry.type Entry type (long/short)
- * @property {number} entry.value Entry price value
- * @property {number} entry.time Entry timestamp
-
- * @property {Object} exit Trade exit
- * @property {'' | string} exit.name Trade name ('' if false exit)
- * @property {number} exit.value Exit price value
- * @property {number} exit.time Exit timestamp
-
- * @property {number} quantity Trade quantity
- * @property {RelAbsValue} profit Trade profit
- * @property {RelAbsValue} cumulative Trade cummulative profit
- * @property {RelAbsValue} runup Trade run-up
- * @property {RelAbsValue} drawdown Trade drawdown
+ * @prop {Object} entry Trade entry
+ * @prop {string} entry.name Trade name
+ * @prop {'long' | 'short'} entry.type Entry type (long/short)
+ * @prop {number} entry.value Entry price value
+ * @prop {number} entry.time Entry timestamp
+
+ * @prop {Object} exit Trade exit
+ * @prop {'' | string} exit.name Trade name ('' if false exit)
+ * @prop {number} exit.value Exit price value
+ * @prop {number} exit.time Exit timestamp
+
+ * @prop {number} quantity Trade quantity
+ * @prop {RelAbsValue} profit Trade profit
+ * @prop {RelAbsValue} cumulative Trade cummulative profit
+ * @prop {RelAbsValue} runup Trade run-up
+ * @prop {RelAbsValue} drawdown Trade drawdown
  */
 
 /**
  * @typedef {Object} PerfReport
- * @property {number} avgBarsInTrade Average bars in trade
- * @property {number} avgBarsInWinTrade Average bars in winning trade
- * @property {number} avgBarsInLossTrade Average bars in losing trade
- * @property {number} avgTrade Average trade gain
- * @property {number} avgTradePercent Average trade performace
- * @property {number} avgLosTrade Average losing trade gain
- * @property {number} avgLosTradePercent Average losing trade performace
- * @property {number} avgWinTrade Average winning trade gain
- * @property {number} avgWinTradePercent Average winning trade performace
- * @property {number} commissionPaid Commission paid
- * @property {number} grossLoss Gross loss value
- * @property {number} grossLossPercent Gross loss percent
- * @property {number} grossProfit Gross profit
- * @property {number} grossProfitPercent Gross profit percent
- * @property {number} largestLosTrade Largest losing trade gain
- * @property {number} largestLosTradePercent Largent losing trade performance (percentage)
- * @property {number} largestWinTrade Largest winning trade gain
- * @property {number} largestWinTradePercent Largest winning trade performance (percentage)
- * @property {number} marginCalls Margin calls
- * @property {number} maxContractsHeld Max Contracts Held
- * @property {number} netProfit Net profit
- * @property {number} netProfitPercent Net performance (percentage)
- * @property {number} numberOfLosingTrades Number of losing trades
- * @property {number} numberOfWiningTrades Number of winning trades
- * @property {number} percentProfitable Strategy winrate
- * @property {number} profitFactor Profit factor
- * @property {number} ratioAvgWinAvgLoss Ratio Average Win / Average Loss
- * @property {number} totalOpenTrades Total open trades
- * @property {number} totalTrades Total trades
+ * @prop {number} avgBarsInTrade Average bars in trade
+ * @prop {number} avgBarsInWinTrade Average bars in winning trade
+ * @prop {number} avgBarsInLossTrade Average bars in losing trade
+ * @prop {number} avgTrade Average trade gain
+ * @prop {number} avgTradePercent Average trade performace
+ * @prop {number} avgLosTrade Average losing trade gain
+ * @prop {number} avgLosTradePercent Average losing trade performace
+ * @prop {number} avgWinTrade Average winning trade gain
+ * @prop {number} avgWinTradePercent Average winning trade performace
+ * @prop {number} commissionPaid Commission paid
+ * @prop {number} grossLoss Gross loss value
+ * @prop {number} grossLossPercent Gross loss percent
+ * @prop {number} grossProfit Gross profit
+ * @prop {number} grossProfitPercent Gross profit percent
+ * @prop {number} largestLosTrade Largest losing trade gain
+ * @prop {number} largestLosTradePercent Largent losing trade performance (percentage)
+ * @prop {number} largestWinTrade Largest winning trade gain
+ * @prop {number} largestWinTradePercent Largest winning trade performance (percentage)
+ * @prop {number} marginCalls Margin calls
+ * @prop {number} maxContractsHeld Max Contracts Held
+ * @prop {number} netProfit Net profit
+ * @prop {number} netProfitPercent Net performance (percentage)
+ * @prop {number} numberOfLosingTrades Number of losing trades
+ * @prop {number} numberOfWiningTrades Number of winning trades
+ * @prop {number} percentProfitable Strategy winrate
+ * @prop {number} profitFactor Profit factor
+ * @prop {number} ratioAvgWinAvgLoss Ratio Average Win / Average Loss
+ * @prop {number} totalOpenTrades Total open trades
+ * @prop {number} totalTrades Total trades
 */
 
 /**
  * @typedef {Object} StrategyReport
- * @property {'EUR' | 'USD' | 'JPY' | '' | 'CHF'} [currency] Selected currency
- * @property {TradeReport[]} trades Trade list starting by the last
- * @property {Object} history History Chart value
- * @property {number[]} [history.buyHold] Buy hold values
- * @property {number[]} [history.buyHoldPercent] Buy hold percent values
- * @property {number[]} [history.drawDown] Drawdown values
- * @property {number[]} [history.drawDownPercent] Drawdown percent values
- * @property {number[]} [history.equity] Equity values
- * @property {number[]} [history.equityPercent] Equity percent values
- * @property {Object} performance Strategy performance
- * @property {PerfReport} [performance.all] Strategy long/short performances
- * @property {PerfReport} [performance.long] Strategy long performances
- * @property {PerfReport} [performance.short] Strategy short performances
- * @property {number} [performance.buyHoldReturn] Strategy Buy & Hold Return
- * @property {number} [performance.buyHoldReturnPercent] Strategy Buy & Hold Return percent
- * @property {number} [performance.maxDrawDown] Strategy max drawdown
- * @property {number} [performance.maxDrawDownPercent] Strategy max drawdown percent
- * @property {number} [performance.openPL] Strategy Open P&L (Profit And Loss)
- * @property {number} [performance.openPLPercent] Strategy Open P&L (Profit And Loss) percent
- * @property {number} [performance.sharpeRatio] Strategy Sharpe Ratio
- * @property {number} [performance.sortinoRatio] Strategy Sortino Ratio
+ * @prop {'EUR' | 'USD' | 'JPY' | '' | 'CHF'} [currency] Selected currency
+ * @prop {TradeReport[]} trades Trade list starting by the last
+ * @prop {Object} history History Chart value
+ * @prop {number[]} [history.buyHold] Buy hold values
+ * @prop {number[]} [history.buyHoldPercent] Buy hold percent values
+ * @prop {number[]} [history.drawDown] Drawdown values
+ * @prop {number[]} [history.drawDownPercent] Drawdown percent values
+ * @prop {number[]} [history.equity] Equity values
+ * @prop {number[]} [history.equityPercent] Equity percent values
+ * @prop {Object} performance Strategy performance
+ * @prop {PerfReport} [performance.all] Strategy long/short performances
+ * @prop {PerfReport} [performance.long] Strategy long performances
+ * @prop {PerfReport} [performance.short] Strategy short performances
+ * @prop {number} [performance.buyHoldReturn] Strategy Buy & Hold Return
+ * @prop {number} [performance.buyHoldReturnPercent] Strategy Buy & Hold Return percent
+ * @prop {number} [performance.maxDrawDown] Strategy max drawdown
+ * @prop {number} [performance.maxDrawDownPercent] Strategy max drawdown percent
+ * @prop {number} [performance.openPL] Strategy Open P&L (Profit And Loss)
+ * @prop {number} [performance.openPLPercent] Strategy Open P&L (Profit And Loss) percent
+ * @prop {number} [performance.sharpeRatio] Strategy Sharpe Ratio
+ * @prop {number} [performance.sortinoRatio] Strategy Sortino Ratio
  */
 
 /**

package/src/classes/BuiltInIndicator.js

@@ -1,5 +1,6 @@
 /**
- * @typedef {'VbPFixed@tv-basicstudies-139!'
+ * @typedef {'Volume@tv-basicstudies-144'
+ *  | 'VbPFixed@tv-basicstudies-139!'
  *  | 'VbPFixed@tv-volumebyprice-53!'
  *  | 'VbPSessions@tv-volumebyprice-53'
  *  | 'VbPSessionsRough@tv-volumebyprice-53!'
@@ -16,6 +17,10 @@
  */
 
 const defaultValues = {
+  'Volume@tv-basicstudies-144': {
+    length: 20,
+    col_prev_close: false,
+  },
   'VbPFixed@tv-basicstudies-139!': {
     rowsLayout: 'Number Of Rows',
     rows: 24,
@@ -63,6 +68,7 @@ const defaultValues = {
   },
 };
 
+/** @class */
 module.exports = class BuiltInIndicator {
   /** @type {BuiltInIndicatorType} */
   #type;

package/src/classes/PineIndicator.js

@@ -4,7 +4,9 @@
  * @property {string} inline Input inline name
  * @property {string} [internalID] Input internal ID
  * @property {string} [tooltip] Input tooltip
- * @property {'text' | 'source' | 'integer' | 'float' | 'resolution' | 'bool'} type Input type
+ * @property {'text' | 'source' | 'integer'
+ *  | 'float' | 'resolution' | 'bool' | 'color'
+ * } type Input type
  * @property {string | number | boolean} value Input default value
  * @property {boolean} isHidden If the input is hidden
  * @property {boolean} isFake If the input is fake
@@ -26,6 +28,8 @@
  * @typedef {'Script@tv-scripting-101!'
  *  | 'StrategyScript@tv-scripting-101!'} IndicatorType Indicator type
  */
+
+/** @class */
 module.exports = class PineIndicator {
   #options;
 
@@ -113,12 +117,8 @@ module.exports = class PineIndicator {
         text: 'String',
       };
 
-      if (
-        (input.type === 'bool' && typeof value !== 'boolean')
-        || (input.type === 'integer' && typeof value !== 'number')
-        || (input.type === 'float' && typeof value !== 'number')
-        || (input.type === 'text' && typeof value !== 'string')
-      ) {
+      // eslint-disable-next-line valid-typeof
+      if (types[input.type] && typeof value !== types[input.type].toLowerCase()) {
         throw new Error(`Input '${input.name}' (${propI}) must be a ${types[input.type]} !`);
       }
 

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);
     }
   }
 
@@ -218,7 +223,7 @@ 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', {
+    this.#ws = new WebSocket('wss://data.tradingview.com/socket.io/websocket', {
       origin: 'https://s.tradingview.com',
     });
 
@@ -273,7 +278,7 @@ module.exports = class Client {
    */
   end() {
     return new Promise((cb) => {
-      this.#ws.close();
+      if (this.#ws.readyState) this.#ws.close();
       cb();
     });
   }