All files Common.ts

100% Statements 40/40
75% Branches 3/4
100% Functions 7/7
100% Lines 39/39

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218        24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x   24x                                                                                       24x       30x         30x                               30x                                                         149x 149x   149x 149x                   149x 149x                           3x                           6x 6x                           4x 4x 4x 4x                           15x 15x 15x 15x      
/**
 * Торговый статус
 * @see https://tinkoff.github.io/investAPI/common/#securitytradingstatus
 */
export enum SecurityTradingStatus {
  /** Торговый статус не определён */
  SECURITY_TRADING_STATUS_UNSPECIFIED,
  /** Недоступен для торгов */
  SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING,
  /** Период открытия торгов */
  SECURITY_TRADING_STATUS_OPENING_PERIOD,
  /** Период закрытия торгов */
  SECURITY_TRADING_STATUS_CLOSING_PERIOD,
  /** Перерыв в торговле */
  SECURITY_TRADING_STATUS_BREAK_IN_TRADING,
  /** Нормальная торговля */
  SECURITY_TRADING_STATUS_NORMAL_TRADING,
  /** Аукцион закрытия */
  SECURITY_TRADING_STATUS_CLOSING_AUCTION,
  /** Аукцион крупных пакетов */
  SECURITY_TRADING_STATUS_DARK_POOL_AUCTION,
  /** Дискретный аукцион */
  SECURITY_TRADING_STATUS_DISCRETE_AUCTION,
  /** Аукцион открытия */
  SECURITY_TRADING_STATUS_OPENING_AUCTION_PERIOD,
  /** Период торгов по цене аукциона закрытия */
  SECURITY_TRADING_STATUS_TRADING_AT_CLOSING_AUCTION_PRICE,
  /** Сессия назначена */
  SECURITY_TRADING_STATUS_SESSION_ASSIGNED,
  /** Сессия закрыта */
  SECURITY_TRADING_STATUS_SESSION_CLOSE,
  /** Сессия открыта */
  SECURITY_TRADING_STATUS_SESSION_OPEN,
  /** Доступна торговля в режиме внутренней ликвидности брокера */
  SECURITY_TRADING_STATUS_DEALER_NORMAL_TRADING,
  /** Перерыв торговли в режиме внутренней ликвидности брокера */
  SECURITY_TRADING_STATUS_DEALER_BREAK_IN_TRADING,
  /** Недоступна торговля в режиме внутренней ликвидности брокера */
  SECURITY_TRADING_STATUS_DEALER_NOT_AVAILABLE_FOR_TRADING
}
 
/**
 * Денежная сумма в определенной валюте
 * @see https://tinkoff.github.io/investAPI/common/#moneyvalue
 */
export interface MoneyValue {
  /** Строковый ISO-код валюты */
  currency: string
  /**
   * Целая часть суммы, может быть отрицательным числом
   * @remarks `int64`
   */
  units: string
  /**
   * Дробная часть суммы, может быть отрицательным числом
   * @remarks `int32`
   */
  nano: number
}
 
/**
 * Котировка - денежная сумма без указания валюты
 * @see https://tinkoff.github.io/investAPI/common/#quotation
 */
export interface Quotation {
  /**
   * Целая часть суммы, может быть отрицательным числом
   * @remarks `int64`
   */
  units: string
  /**
   * Дробная часть суммы, может быть отрицательным числом
   * @remarks `int32`
   */
  nano: number
}
 
/**
 * Общий класс
 * 1. Позволяет сделать `HTTP` запрос к серверу **Tinkoff Invest API**
 * 2. Конвертировать `MoneyValue` и `Quotation` в обе стороны
 */
export class Common {
  /**
   * Продуктивный сервер
   */
  private production = 'https://invest-public-api.tinkoff.ru'
 
  /**
   * Сервер песочницы
   */
  private development = 'https://sandbox-invest-public-api.tinkoff.ru'
 
  /**
   * Инициализация класса
   * ```js
   * import { SandboxService } from '@tomasevich/tinkoff'
   *
   * // Для работы с реальными данными
   * const realServer = new SandboxService('<REAL_TOKEN>', false)
   *
   * // Для работы с данными в тестовом режиме
   * const sandboxServer = new SandboxService('<SANDBOX_TOKEN>', true)
   * ```
   * @param token Токен приложения
   * @param isSandbox Флаг включения режима `Песочницы`
   */
  constructor(private token: string, private isSandbox: boolean) {}
 
  /**
   * Метод `HTTP` запроса к серверу **Tinkoff Invest API**
   * ```js
   * import { Common } from '@tomasevich/tinkoff'
   *
   * class Application extends Common {
   *  public SandboxService(body) {
   *    return this.request('SandboxService', 'GetSandboxOrders', body)
   *  }
   * }
   *
   * const app = new Application('<TOKEN>', true)
   * const { orders } = await app.SandboxService({
   *  accountId: '<ACCOUNT_ID>'
   * })
   *
   * console.log(orders)
   * ```
   * @param service Имя сервиса
   * @param operation Имя операции
   * @param body Тело запроса
   */
  protected async request(
    service: string,
    operation: string,
    body: any
  ): Promise<any> {
    const server = this.isSandbox ? this.development : this.production
    const contract = '/rest/tinkoff.public.invest.api.contract.v1.'
 
    const url = server + contract + service + '/' + operation
    const opt = {
      method: 'POST',
      headers: {
        Accept: 'application/json',
        'Content-Type': 'application/json',
        Authorization: `Bearer ${this.token}`
      },
      body: JSON.stringify(body)
    }
 
    const res = await fetch(url, opt)
    return res.json()
  }
 
  /**
   * Статичный метод конвертирования денежной суммы в определенной валюте в строку
   * ```js
   * import { Common } from '@tomasevich/tinkoff'
   *
   * console.log(Common.MoneyValueToString({ units: '114', nano: 250000000, currency: 'rub' })) // '114.25 rub'
   * console.log(Common.MoneyValueToString({ units: '-200', nano: -200000000, currency: 'usd' })) // '-200.20 usd'
   * console.log(Common.MoneyValueToString({ units: '-0', nano: -10000000, currency: 'eur' })) // '-0.01 eur'
   * ```
   */
  public static MoneyValueToString(moneyValue: MoneyValue): string {
    return `${Common.QuotationToString(moneyValue)} ${moneyValue.currency}`
  }
 
  /**
   * Статичный метод конвертирования котировки в строку
   * ```js
   * import { Common } from '@tomasevich/tinkoff'
   *
   * console.log(Common.QuotationToString({ units: '114', nano: 250000000 })) // '114.25'
   * console.log(Common.QuotationToString({ units: '-200', nano: -200000000 })) // '-200.20'
   * console.log(Common.QuotationToString({ units: '-0', nano: -10000000 })) // '-0.01'
   * ```
   */
  public static QuotationToString(quotation: Quotation): string {
    const nano = String(Math.abs(quotation.nano) / 1000000000).split('.')[1]
    return `${quotation.units}.${nano}`
  }
 
  /**
   * Статичный метод конвертирования строки в денежную сумму в определенной валюте
   * ```js
   * import { Common } from '@tomasevich/tinkoff'
   *
   * console.log(Common.StringToMoneyValue('114.25 rub')) // { units: '114', nano: 250000000, currency: 'rub' }
   * console.log(Common.StringToMoneyValue('-200.20 usd')) // { units: '-200', nano: -200000000, currency: 'usd' }
   * console.log(Common.StringToMoneyValue('-0.01 eur')) // { units: '-0', nano: -10000000, currency: 'eur' }
   * ```
   */
  public static StringToMoneyValue(moneyValue: string): MoneyValue {
    const price = moneyValue.split(' ')
    const quotation = price[0]
    const currency = price[1]
    return { ...Common.StringToQuotation(quotation), currency }
  }
 
  /**
   * Статичный метод конвертирования строки в котировку
   * ```js
   * import { Common } from '@tomasevich/tinkoff'
   *
   * console.log(Common.StringToQuotation('114.25')) // { units: '114', nano: 250000000 }
   * console.log(Common.StringToQuotation('-200.20')) // { units: '-200', nano: -200000000 }
   * console.log(Common.StringToQuotation('-0.01')) // { units: '-0', nano: -10000000 }
   * ```
   */
  public static StringToQuotation(quotation: string): Quotation {
    const number = Number(quotation.replace(',', '.'))
    const units = number.toFixed(0)
    const nano = Number(Math.round((number - Number(units)) * 1000000000))
    return { units, nano }
  }
}