Skip to content

πŸ“ˆ Get real-time stocks from TradingView

3.5 KB
Raw Blame
import { TradingViewError } from '../errors.js';

/** Known built-in (non-Pine) study types. Any other type string is accepted too. */
export type BuiltInIndicatorType =
  | 'Volume@tv-basicstudies-241'
  | 'VbPFixed@tv-basicstudies-241'
  | 'VbPFixed@tv-basicstudies-241!'
  | 'VbPFixed@tv-volumebyprice-53!'
  | 'VbPSessions@tv-volumebyprice-53'
  | 'VbPSessionsRough@tv-volumebyprice-53!'
  | 'VbPSessionsDetailed@tv-volumebyprice-53!'
  | 'VbPVisible@tv-volumebyprice-53'
  | (string & {});

export type BuiltInIndicatorOption =
  | 'length' | 'col_prev_close'
  | 'rowsLayout' | 'rows' | 'volume' | 'vaVolume' | 'subscribeRealtime'
  | 'first_bar_time' | 'first_visible_bar_time' | 'last_bar_time' | 'last_visible_bar_time'
  | 'extendToRight' | 'mapRightBoundaryToBarStartTime' | 'extendPocRight' | (string & {});

function defaultOptions(type: string): Record<string, unknown> | undefined {
  const now = Date.now();
  const profile = {
    rowsLayout: 'Number Of Rows', rows: 24, volume: 'Up/Down', vaVolume: 70,
  };
  switch (type) {
    case 'Volume@tv-basicstudies-241':
      return { length: 20, col_prev_close: false };
    case 'VbPFixed@tv-basicstudies-241':
      return {
        ...profile,
        subscribeRealtime: false,
        first_bar_time: NaN,
        last_bar_time: now,
        extendToRight: false,
        mapRightBoundaryToBarStartTime: true,
      };
    case 'VbPFixed@tv-basicstudies-241!':
    case 'VbPFixed@tv-volumebyprice-53!':
      return {
        ...profile, subscribeRealtime: false, first_bar_time: NaN, last_bar_time: now,
      };
    case 'VbPSessions@tv-volumebyprice-53':
      return { ...profile, extendPocRight: false };
    case 'VbPSessionsRough@tv-volumebyprice-53!':
      return { volume: 'Up/Down', vaVolume: 70 };
    case 'VbPSessionsDetailed@tv-volumebyprice-53!':
      return {
        volume: 'Up/Down', vaVolume: 70, subscribeRealtime: false, first_visible_bar_time: NaN, last_visible_bar_time: now,
      };
    case 'VbPVisible@tv-volumebyprice-53':
      return {
        ...profile, subscribeRealtime: false, first_visible_bar_time: NaN, last_visible_bar_time: now,
      };
    default:
      return undefined;
  }
}

/** A built-in TradingView study such as Volume or Volume Profile. */
export class BuiltInIndicator {
  readonly type: BuiltInIndicatorType;

  readonly options: Record<string, unknown>;

  readonly #defaults: Record<string, unknown> | undefined;

  constructor(type: BuiltInIndicatorType, options: Record<string, unknown> = {}) {
    if (!type) throw new TradingViewError('INVALID_ARGUMENT', 'A built-in indicator type is required');
    this.type = type;
    this.#defaults = defaultOptions(type);
    this.options = { ...this.#defaults };
    for (const [key, value] of Object.entries(options)) this.setOption(key, value);
  }

  /**
   * Changes an option. For known types, the key and value type are validated
   * unless `force` is true.
   */
  setOption(key: BuiltInIndicatorOption, value: unknown, force = false): this {
    if (!force && this.#defaults) {
      if (!(key in this.#defaults)) {
        throw new TradingViewError('INVALID_ARGUMENT', `Option '${key}' is not allowed for '${this.type}'`);
      }
      const expected = typeof this.#defaults[key];
      if (typeof value !== expected) {
        throw new TradingViewError('INVALID_ARGUMENT', `Option '${key}' must be a ${expected}`);
      }
    }
    this.options[key] = value;
    return this;
  }

  /** Parameters sent with `create_study` / `modify_study`. */
  toStudyInputs(): Record<string, unknown> {
    return { ...this.options };
  }
}