@mathieuc/tradingview 2.0.9 → 3.0.1

package/src/chart/graphicParser.js

@@ -0,0 +1,308 @@
+const TRANSLATOR = {
+  /** @typedef {'right' | 'left' | 'both' | 'none'} ExtendValue */
+  extend: {
+    r: 'right',
+    l: 'left',
+    b: 'both',
+    n: 'none',
+  },
+
+  /** @typedef {'price' | 'abovebar' | 'belowbar'} yLocValue */
+  yLoc: {
+    pr: 'price',
+    ab: 'abovebar',
+    bl: 'belowbar',
+  },
+
+  /**
+   * @typedef {'none' | 'xcross' | 'cross' | 'triangleup'
+   * | 'triangledown' | 'flag' | 'circle' | 'arrowup'
+   * | 'arrowdown' | 'label_up' | 'label_down' | 'label_left'
+   * | 'label_right' | 'label_lower_left' | 'label_lower_right'
+   * | 'label_upper_left' | 'label_upper_right' | 'label_center'
+   * | 'square' | 'diamond'
+   * } LabelStyleValue
+   * */
+  labelStyle: {
+    n: 'none',
+    xcr: 'xcross',
+    cr: 'cross',
+    tup: 'triangleup',
+    tdn: 'triangledown',
+    flg: 'flag',
+    cir: 'circle',
+    aup: 'arrowup',
+    adn: 'arrowdown',
+    lup: 'label_up',
+    ldn: 'label_down',
+    llf: 'label_left',
+    lrg: 'label_right',
+    llwlf: 'label_lower_left',
+    llwrg: 'label_lower_right',
+    luplf: 'label_upper_left',
+    luprg: 'label_upper_right',
+    lcn: 'label_center',
+    sq: 'square',
+    dia: 'diamond',
+  },
+
+  /**
+   * @typedef {'solid' | 'dotted' | 'dashed'| 'arrow_left'
+   * | 'arrow_right' | 'arrow_both'} LineStyleValue
+   */
+  lineStyle: {
+    sol: 'solid',
+    dot: 'dotted',
+    dsh: 'dashed',
+    al: 'arrow_left',
+    ar: 'arrow_right',
+    ab: 'arrow_both',
+  },
+
+  /** @typedef {'solid' | 'dotted' | 'dashed'} BoxStyleValue */
+  boxStyle: {
+    sol: 'solid',
+    dot: 'dotted',
+    dsh: 'dashed',
+  },
+};
+
+/**
+ * @typedef {'auto' | 'huge' | 'large'
+ * | 'normal' | 'small' | 'tiny'} SizeValue
+ */
+/** @typedef {'top' | 'center' | 'bottom'} VAlignValue */
+/** @typedef {'left' | 'center' | 'right'} HAlignValue */
+/** @typedef {'none' | 'auto'} TextWrapValue */
+/**
+ * @typedef {'top_left' | 'top_center' | 'top_right'
+ * | 'middle_left' | 'middle_center' | 'middle_right'
+ * | 'bottom_left' | 'bottom_center' | 'bottom_right'
+ * } TablePositionValue
+ */
+
+/**
+ * @typedef {Object} GraphicLabel
+ * @prop {number} id Drawing ID
+ * @prop {number} x Label x position
+ * @prop {number} y Label y position
+ * @prop {yLocValue} yLoc yLoc mode
+ * @prop {string} text Label text
+ * @prop {LabelStyleValue} style Label style
+ * @prop {number} color
+ * @prop {number} textColor
+ * @prop {SizeValue} size Label size
+ * @prop {HAlignValue} textAlign Text horizontal align
+ * @prop {string} toolTip Tooltip text
+ */
+
+/**
+ * @typedef {Object} GraphicLine
+ * @prop {number} id Drawing ID
+ * @prop {number} x1 First x position
+ * @prop {number} y1 First y position
+ * @prop {number} x2 Second x position
+ * @prop {number} y2 Second y position
+ * @prop {ExtendValue} extend Horizontal extend
+ * @prop {LineStyleValue} style Line style
+ * @prop {number} color Line color
+ * @prop {number} width Line width
+ */
+
+/**
+ * @typedef {Object} GraphicBox
+ * @prop {number} id Drawing ID
+ * @prop {number} x1 First x position
+ * @prop {number} y1 First y position
+ * @prop {number} x2 Second x position
+ * @prop {number} y2 Second y position
+ * @prop {number} color Box color
+ * @prop {number} bgColor Background color
+ * @prop {ExtendValue} extend Horizontal extend
+ * @prop {BoxStyleValue} style Box style
+ * @prop {number} width Box width
+ * @prop {string} text Text
+ * @prop {SizeValue} textSize Text size
+ * @prop {number} textColor Text color
+ * @prop {VAlignValue} textVAlign Text vertical align
+ * @prop {HAlignValue} textHAlign Text horizontal align
+ * @prop {TextWrapValue} textWrap Text wrap
+ */
+
+/**
+ * @typedef {Object} TableCell
+ * @prop {number} id Drawing ID
+ * @prop {string} text Cell text
+ * @prop {number} width Cell width
+ * @prop {number} height Cell height
+ * @prop {number} textColor Text color
+ * @prop {HAlignValue} textHAlign Text horizontal align
+ * @prop {VAlignValue} textVAlign Text Vertical align
+ * @prop {SizeValue} textSize Text size
+ * @prop {number} bgColor Background color
+ */
+
+/**
+ * @typedef {Object} GraphicTable
+ * @prop {number} id Drawing ID
+ * @prop {TablePositionValue} position Table position
+ * @prop {number} rows Number of rows
+ * @prop {number} columns Number of columns
+ * @prop {number} bgColor Background color
+ * @prop {number} frameColor Frame color
+ * @prop {number} frameWidth Frame width
+ * @prop {number} borderColor Border color
+ * @prop {number} borderWidth Border width
+ * @prop {() => TableCell[][]} cells Table cells matrix
+ */
+
+/**
+ * @typedef {Object} GraphicHorizline
+ * @prop {number} id Drawing ID
+ * @prop {number} level Y position of the line
+ * @prop {number} startIndex Start index of the line (`chart.periods[line.startIndex]`)
+ * @prop {number} endIndex End index of the line (`chart.periods[line.endIndex]`)
+ * @prop {boolean} extendRight Is the line extended to the right
+ * @prop {boolean} extendLeft Is the line extended to the left
+ */
+
+/**
+ * @typedef {Object} GraphicPoint
+ * @prop {number} index X position of the point
+ * @prop {number} level Y position of the point
+ */
+
+/**
+ * @typedef {Object} GraphicPolygon
+ * @prop {number} id Drawing ID
+ * @prop {GraphicPoint[]} points List of polygon points
+ */
+
+/**
+ * @typedef {Object} GraphicHorizHist
+ * @prop {number} id Drawing ID
+ * @prop {number} priceLow Low Y position
+ * @prop {number} priceHigh High Y position
+ * @prop {number} firstBarTime First X position
+ * @prop {number} lastBarTime Last X position
+ * @prop {number[]} rate List of values
+ */
+
+/**
+ * @typedef {Object} GraphicData List of drawings indexed by type
+ * @prop {GraphicLabel[]} labels List of labels drawings
+ * @prop {GraphicLine[]} lines List of lines drawings
+ * @prop {GraphicBox[]} boxes List of boxes drawings
+ * @prop {GraphicTable[]} tables List of tables drawings
+ * @prop {GraphicPolygon[]} polygons List of polygons drawings
+ * @prop {GraphicHorizHist[]} horizHists List of horizontal histograms drawings
+ * @prop {GraphicHorizline[]} horizLines List of horizontal lines drawings
+ */
+
+/**
+ * @param {Object} rawGraphic Raw graphic data
+ * @param {Object} indexes Drawings xPos indexes
+ * @returns {GraphicData}
+ */
+module.exports = function graphicParse(rawGraphic = {}, indexes = []) {
+  // console.log('indexes', indexes);
+  return {
+    labels: Object.values(rawGraphic.dwglabels ?? {}).map((l) => ({
+      id: l.id,
+      x: indexes[l.x],
+      y: l.y,
+      yLoc: TRANSLATOR.yLoc[l.yl] ?? l.yl,
+      text: l.t,
+      style: TRANSLATOR.labelStyle[l.st] ?? l.st,
+      color: l.ci,
+      textColor: l.tci,
+      size: l.sz,
+      textAlign: l.ta,
+      toolTip: l.tt,
+    })),
+
+    lines: Object.values(rawGraphic.dwglines ?? {}).map((l) => ({
+      id: l.id,
+      x1: indexes[l.x1],
+      y1: l.y1,
+      x2: indexes[l.x2],
+      y2: l.y2,
+      extend: TRANSLATOR.extend[l.ex] ?? l.ex,
+      style: TRANSLATOR.lineStyle[l.st] ?? l.st,
+      color: l.ci,
+      width: l.w,
+    })),
+
+    boxes: Object.values(rawGraphic.dwgboxes ?? {}).map((b) => ({
+      id: b.id,
+      x1: indexes[b.x1],
+      y1: b.y1,
+      x2: indexes[b.x2],
+      y2: b.y2,
+      color: b.c,
+      bgColor: b.bc,
+      extend: TRANSLATOR.extend[b.ex] ?? b.ex,
+      style: TRANSLATOR.boxStyle[b.st] ?? b.st,
+      width: b.w,
+      text: b.t,
+      textSize: b.ts,
+      textColor: b.tc,
+      textVAlign: b.tva,
+      textHAlign: b.tha,
+      textWrap: b.tw,
+    })),
+
+    tables: Object.values(rawGraphic.dwgtables ?? {}).map((t) => ({
+      id: t.id,
+      position: t.pos,
+      rows: t.rows,
+      columns: t.cols,
+      bgColor: t.bgc,
+      frameColor: t.frmc,
+      frameWidth: t.frmw,
+      borderColor: t.brdc,
+      borderWidth: t.brdw,
+      cells: () => {
+        const matrix = [];
+        Object.values(rawGraphic.dwgtablecells ?? {}).forEach((cell) => {
+          if (cell.tid !== t.id) return;
+          if (!matrix[cell.row]) matrix[cell.row] = [];
+          matrix[cell.row][cell.col] = {
+            id: cell.id,
+            text: cell.t,
+            width: cell.w,
+            height: cell.h,
+            textColor: cell.tc,
+            textHAlign: cell.tha,
+            textVAlign: cell.tva,
+            textSize: cell.ts,
+            bgColor: cell.bgc,
+          };
+        });
+        return matrix;
+      },
+    })),
+
+    horizLines: Object.values(rawGraphic.horizlines ?? {}).map((h) => ({
+      ...h,
+      startIndex: indexes[h.startIndex],
+      endIndex: indexes[h.endIndex],
+    })),
+
+    polygons: Object.values(rawGraphic.polygons ?? {}).map((p) => ({
+      ...p,
+      points: p.points.map((pt) => ({
+        ...pt,
+        index: indexes[pt.index],
+      })),
+    })),
+
+    horizHists: Object.values(rawGraphic.hhists ?? {}).map((h) => ({
+      ...h,
+      firstBarTime: indexes[h.firstBarTime],
+      lastBarTime: indexes[h.lastBarTime],
+    })),
+
+    raw: () => rawGraphic,
+  };
+};

package/src/chart/session.js

@@ -0,0 +1,372 @@
+const { genSessionID } = require('../utils');
+
+const studyConstructor = require('./study');
+
+/**
+ * @typedef {'HeikinAshi' | 'Renko' | 'LineBreak' | 'Kagi' | 'PointAndFigure'
+ *  | 'Range'} ChartType Custom chart type
+ */
+
+const ChartTypes = {
+  HeikinAshi: 'BarSetHeikenAshi@tv-basicstudies-60!',
+  Renko: 'BarSetRenko@tv-prostudies-40!',
+  LineBreak: 'BarSetPriceBreak@tv-prostudies-34!',
+  Kagi: 'BarSetKagi@tv-prostudies-34!',
+  PointAndFigure: 'BarSetPnF@tv-prostudies-34!',
+  Range: 'BarSetRange@tv-basicstudies-72!',
+};
+
+/**
+ * @typedef {Object} ChartInputs Custom chart type
+ * @prop {number} [atrLength] Renko/Kagi/PointAndFigure ATR length
+ * @prop {'open' | 'high' | 'low' | 'close' | 'hl2'
+ *  | 'hlc3' | 'ohlc4'} [source] Renko/LineBreak/Kagi source
+ * @prop {'ATR' | string} [style] Renko/Kagi/PointAndFigure style
+ * @prop {number} [boxSize] Renko/PointAndFigure box size
+ * @prop {number} [reversalAmount] Kagi/PointAndFigure reversal amount
+ * @prop {'Close'} [sources] Renko/PointAndFigure sources
+ * @prop {boolean} [wicks] Renko wicks
+ * @prop {number} [lb] LineBreak Line break
+ * @prop {boolean} [oneStepBackBuilding] PointAndFigure oneStepBackBuilding
+ * @prop {boolean} [phantomBars] Range phantom bars
+ * @prop {boolean} [range] Range range
+ */
+
+/** @typedef {Object<string, Function[]>} StudyListeners */
+
+/**
+ * @typedef {Object} ChartSessionBridge
+ * @prop {string} sessionID
+ * @prop {StudyListeners} studyListeners
+ * @prop {Object<number, number>} indexes
+ * @prop {import('../client').SendPacket} send
+*/
+
+/**
+ * @typedef {'seriesLoaded' | 'symbolLoaded' | 'update' | 'error'} ChartEvent
+ */
+
+/**
+ * @typedef {Object} PricePeriod
+ * @prop {number} time Period timestamp
+ * @prop {number} open Period open value
+ * @prop {number} close Period close value
+ * @prop {number} max Period max value
+ * @prop {number} min Period min value
+ * @prop {number} volume Period volume value
+ */
+
+/**
+ * @typedef {Object} Subsession
+ * @prop {string} id Subsession ID (ex: 'regular')
+ * @prop {string} description Subsession description (ex: 'Regular')
+ * @prop {boolean} private If private
+ * @prop {string} session Session (ex: '24x7')
+ * @prop {string} session-correction Session correction
+ * @prop {string} session-display Session display (ex: '24x7')
+ *
+ * @typedef {Object} MarketInfos
+ * @prop {string} series_id            Used series (ex: 'ser_1')
+ * @prop {string} base_currency        Base currency (ex: 'BTC')
+ * @prop {string} base_currency_id     Base currency ID (ex: 'XTVCBTC')
+ * @prop {string} name                 Market short name (ex: 'BTCEUR')
+ * @prop {string} full_name            Market full name (ex: 'COINBASE:BTCEUR')
+ * @prop {string} pro_name             Market pro name (ex: 'COINBASE:BTCEUR')
+ * @prop {string} description          Market symbol description (ex: 'BTC/EUR')
+ * @prop {string} short_description    Market symbol short description (ex: 'BTC/EUR')
+ * @prop {string} exchange             Market exchange (ex: 'COINBASE')
+ * @prop {string} listed_exchange      Market exchange (ex: 'COINBASE')
+ * @prop {string} provider_id          Values provider ID (ex: 'coinbase')
+ * @prop {string} currency_id          Used currency ID (ex: 'EUR')
+ * @prop {string} currency_code        Used currency code (ex: 'EUR')
+ * @prop {string} variable_tick_size   Variable tick size
+ * @prop {number} pricescale           Price scale
+ * @prop {number} pointvalue           Point value
+ * @prop {string} session              Session (ex: '24x7')
+ * @prop {string} session_display      Session display (ex: '24x7')
+ * @prop {string} type                 Market type (ex: 'crypto')
+ * @prop {boolean} has_intraday        If intraday values are available
+ * @prop {boolean} fractional          If market is fractional
+ * @prop {boolean} is_tradable         If the market is curently tradable
+ * @prop {number} minmov               Minimum move value
+ * @prop {number} minmove2             Minimum move value 2
+ * @prop {string} timezone             Used timezone
+ * @prop {boolean} is_replayable       If the replay mode is available
+ * @prop {boolean} has_adjustment      If the adjustment mode is enabled
+ * @prop {boolean} has_extended_hours  Has extended hours
+ * @prop {string} bar_source           Bar source
+ * @prop {string} bar_transform        Bar transform
+ * @prop {boolean} bar_fillgaps        Bar fill gaps
+ * @prop {string} allowed_adjustment   Allowed adjustment (ex: 'none')
+ * @prop {string} subsession_id        Subsession ID (ex: 'regular')
+ * @prop {string} pro_perm             Pro permission (ex: '')
+ * @prop {[]} base_name                Base name (ex: ['COINBASE:BTCEUR'])
+ * @prop {[]} legs                     Legs (ex: ['COINBASE:BTCEUR'])
+ * @prop {Subsession[]} subsessions    Sub sessions
+ * @prop {[]} typespecs                Typespecs (ex: [])
+ * @prop {[]} resolutions              Resolutions (ex: [])
+ * @prop {[]} aliases                  Aliases (ex: [])
+ * @prop {[]} alternatives             Alternatives (ex: [])
+ */
+
+/**
+ * @param {import('../client').ClientBridge} client
+ */
+module.exports = (client) => class ChartSession {
+  #sessionID = genSessionID('cs');
+
+  /** Parent client */
+  #client = client;
+
+  /** @type {StudyListeners} */
+  #studyListeners = {};
+
+  /**
+   * Table of periods values indexed by timestamp
+   * @type {Object<number, PricePeriod[]>}
+   */
+  #periods = {};
+
+  /** @return {PricePeriod[]} List of periods values */
+  get periods() {
+    return Object.values(this.#periods).sort((a, b) => b.time - a.time);
+  }
+
+  /**
+   * Current market infos
+   * @type {MarketInfos}
+   */
+  #infos = {};
+
+  /** @return {MarketInfos} Current market infos */
+  get infos() {
+    return this.#infos;
+  }
+
+  #callbacks = {
+    seriesLoaded: [],
+    symbolLoaded: [],
+    update: [],
+
+    event: [],
+    error: [],
+  };
+
+  /**
+   * @param {ChartEvent} ev Client event
+   * @param {...{}} data Packet data
+   */
+  #handleEvent(ev, ...data) {
+    this.#callbacks[ev].forEach((e) => e(...data));
+    this.#callbacks.event.forEach((e) => e(ev, ...data));
+  }
+
+  #handleError(...msgs) {
+    if (this.#callbacks.error.length === 0) console.error(...msgs);
+    else this.#handleEvent('error', ...msgs);
+  }
+
+  constructor() {
+    this.#client.sessions[this.#sessionID] = {
+      type: 'chart',
+      onData: (packet) => {
+        if (global.TW_DEBUG) console.log('§90§30§106 CHART SESSION §0 DATA', packet);
+
+        if (typeof packet.data[1] === 'string' && this.#studyListeners[packet.data[1]]) {
+          this.#studyListeners[packet.data[1]](packet);
+          return;
+        }
+
+        if (packet.type === 'symbol_resolved') {
+          this.#infos = {
+            series_id: packet.data[1],
+            ...packet.data[2],
+          };
+
+          this.#handleEvent('symbolLoaded');
+          return;
+        }
+
+        if (['timescale_update', 'du'].includes(packet.type)) {
+          Object.keys(packet.data[1]).forEach((k) => {
+            if (k === '$prices') {
+              const periods = packet.data[1].$prices;
+              if (!periods || !periods.s) return;
+
+              periods.s.forEach((p) => {
+                [this.#chartSession.indexes[p.i]] = p.v;
+                this.#periods[p.v[0]] = {
+                  time: p.v[0],
+                  open: p.v[1],
+                  close: p.v[4],
+                  max: p.v[2],
+                  min: p.v[3],
+                  volume: Math.round(p.v[5] * 100) / 100,
+                };
+              });
+
+              return;
+            }
+
+            if (this.#studyListeners[k]) this.#studyListeners[k](packet);
+          });
+
+          this.#handleEvent('update');
+          return;
+        }
+
+        if (packet.type === 'symbol_error') {
+          this.#handleError(`(${packet.data[1]}) Symbol error:`, packet.data[2]);
+          return;
+        }
+
+        if (packet.type === 'series_error') {
+          this.#handleError('Series error:', packet.data[3]);
+          return;
+        }
+
+        if (packet.type === 'critical_error') {
+          const [, name, description] = packet.data;
+          this.#handleError('Critical error:', name, description);
+        }
+      },
+    };
+
+    this.#client.send('chart_create_session', [this.#sessionID]);
+  }
+
+  #seriesCreated = false;
+
+  #currentSeries = 0;
+
+  /**
+   * @param {import('../types').TimeFrame} timeframe Chart period timeframe
+   * @param {number} [range] Number of loaded periods/candles (Default: 100)
+   * @param {number} [reference] Reference candle timestamp (Default is now)
+   */
+  setSeries(timeframe = '240', range = 100, reference = null) {
+    if (!this.#currentSeries) {
+      this.#handleError('Please set the market before setting series');
+      return;
+    }
+
+    const calcRange = !reference ? range : ['bar_count', reference, range];
+
+    this.#periods = {};
+
+    this.#client.send(`${this.#seriesCreated ? 'modify' : 'create'}_series`, [
+      this.#sessionID,
+      '$prices',
+      's1',
+      `ser_${this.#currentSeries}`,
+      timeframe,
+      this.#seriesCreated ? '' : calcRange,
+    ]);
+
+    this.#seriesCreated = true;
+  }
+
+  /**
+   * Set the chart market
+   * @param {string} symbol Market symbol
+   * @param {Object} [options] Chart options
+   * @param {import('../types').TimeFrame} [options.timeframe] Chart period timeframe
+   * @param {number} [options.range] Number of loaded periods/candles (Default: 100)
+   * @param {number} [options.to] Last candle timestamp (Default is now)
+   * @param {'splits' | 'dividends'} [options.adjustment] Market adjustment
+   * @param {'regular' | 'extended'} [options.session] Chart session
+   * @param {'EUR' | 'USD' | string} [options.currency] Chart currency
+   * @param {ChartType} [options.type] Chart custom type
+   * @param {ChartInputs} [options.inputs] Chart custom inputs
+   */
+  setMarket(symbol, options = {}) {
+    this.#periods = {};
+
+    const symbolInit = {
+      symbol: symbol || 'BTCEUR',
+      adjustment: options.adjustment || 'splits',
+    };
+
+    if (options.session) symbolInit.session = options.session;
+
+    if (options.currency) symbolInit['currency-id'] = options.currency;
+
+    const chartInit = (options.type && ChartTypes[options.type]) ? {} : symbolInit;
+
+    if (options.type && ChartTypes[options.type]) {
+      chartInit.symbol = symbolInit;
+      chartInit.type = ChartTypes[options.type];
+      chartInit.inputs = { ...options.inputs };
+    }
+
+    this.#currentSeries += 1;
+
+    this.#client.send('resolve_symbol', [
+      this.#sessionID,
+      `ser_${this.#currentSeries}`,
+      `=${JSON.stringify(chartInit)}`,
+    ]);
+
+    this.setSeries(options.timeframe, options.range, options.to);
+  }
+
+  /**
+   * Set the chart timezone
+   * @param {import('../types').Timezone} timezone New timezone
+   */
+  setTimezone(timezone) {
+    this.#periods = {};
+    this.#client.send('switch_timezone', [this.#sessionID, timezone]);
+  }
+
+  /**
+   * Fetch x additional previous periods/candles values
+   * @param {number} number Number of additional periods/candles you want to fetch
+   */
+  fetchMore(number = 1) {
+    this.#client.send('request_more_data', [this.#sessionID, '$prices', number]);
+  }
+
+  /**
+   * When a symbol is loaded
+   * @param {() => void} cb
+   * @event
+   */
+  onSymbolLoaded(cb) {
+    this.#callbacks.symbolLoaded.push(cb);
+  }
+
+  /**
+   * When a chart update happens
+   * @param {() => void} cb
+   * @event
+   */
+  onUpdate(cb) {
+    this.#callbacks.update.push(cb);
+  }
+
+  /**
+   * When chart error happens
+   * @param {(...any) => void} cb Callback
+   * @event
+   */
+  onError(cb) {
+    this.#callbacks.error.push(cb);
+  }
+
+  /** @type {ChartSessionBridge} */
+  #chartSession = {
+    sessionID: this.#sessionID,
+    studyListeners: this.#studyListeners,
+    indexes: {},
+    send: (t, p) => this.#client.send(t, p),
+  };
+
+  Study = studyConstructor(this.#chartSession);
+
+  /** Delete the chart session */
+  delete() {
+    this.#client.send('quote_delete_session', [this.#sessionID]);
+    delete this.#client.sessions[this.#sessionID];
+  }
+};