@oanda/labs-order-book-widget 1.0.226 → 1.0.228

package/dist/types/gql/types/graphql.d.ts

@@ -53,6 +53,7 @@ export declare enum AssetClassName {
     Cryptocurrency = "CRYPTOCURRENCY",
     Currency = "CURRENCY",
     EquityShares = "EQUITY_SHARES",
+    Etfs = "ETFS",
     Indices = "INDICES",
     Rates = "RATES"
 }
@@ -60,6 +61,23 @@ export declare enum BookType {
     Order = "ORDER",
     Position = "POSITION"
 }
+export type Candle = {
+    __typename?: 'Candle';
+    close: Scalars['Float']['output'];
+    high: Scalars['Float']['output'];
+    low: Scalars['Float']['output'];
+    open: Scalars['Float']['output'];
+    /** UTC Timestamp */
+    point: Scalars['String']['output'];
+};
+export type CandlesData = {
+    __typename?: 'CandlesData';
+    candle: Array<Maybe<Candle>>;
+    granularity: Granularity;
+    instrument: Instrument;
+    pipsLocation: Scalars['Int']['output'];
+    timeSpan: TimeSpan;
+};
 export type CorrelationHeatmap = {
     __typename?: 'CorrelationHeatmap';
     baseInstrument: Instrument;
@@ -119,8 +137,9 @@ export type CurrencyStrength = {
     updatedAt: Scalars['String']['output'];
 };
 export declare enum DataSource {
-    Ny4 = "NY4",
-    Ty3 = "TY3"
+    All = "ALL",
+    Mt5 = "MT5",
+    V20 = "V20"
 }
 export declare enum Division {
     Oap = "OAP",
@@ -133,6 +152,19 @@ export declare enum Division {
     Opt = "OPT",
     Otms = "OTMS"
 }
+export type ExtendedInstrument = {
+    __typename?: 'ExtendedInstrument';
+    dataSource: DataSource;
+    displayName: Scalars['String']['output'];
+    name: Scalars['String']['output'];
+    tradeMode: TradeMode;
+};
+export declare enum Granularity {
+    H1 = "H1",
+    H4 = "H4",
+    M5 = "M5",
+    M15 = "M15"
+}
 export type Heatmap = {
     __typename?: 'Heatmap';
     instrument: Instrument;
@@ -148,16 +180,33 @@ export type InstrumentCorrelation = {
     instrument: Instrument;
     value?: Maybe<Scalars['Float']['output']>;
 };
+export type InstrumentTableResult = {
+    __typename?: 'InstrumentTableResult';
+    instruments: Array<ExtendedInstrument>;
+    totalCount: Scalars['Int']['output'];
+    updatedAt: Scalars['String']['output'];
+};
+export type MarginRate = {
+    __typename?: 'MarginRate';
+    instrument: Instrument;
+    rate: Scalars['Float']['output'];
+};
 export type Matrix = {
     __typename?: 'Matrix';
     instrument: Instrument;
     instrumentCorrelation: Array<InstrumentCorrelation>;
 };
+export declare enum OrderBookDataSource {
+    Ny4 = "NY4",
+    Ny4Mt5 = "NY4_MT5",
+    Ty3 = "TY3"
+}
 export type OrderPositionBucket = {
     __typename?: 'OrderPositionBucket';
-    longCountPercent: Scalars['Float']['output'];
+    longCountPercent?: Maybe<Scalars['Float']['output']>;
     price: Scalars['Float']['output'];
-    shortCountPercent: Scalars['Float']['output'];
+    sentiment?: Maybe<Scalars['Float']['output']>;
+    shortCountPercent?: Maybe<Scalars['Float']['output']>;
 };
 export type OrderPositionData = {
     __typename?: 'OrderPositionData';
@@ -177,10 +226,17 @@ export type Query = {
     correlationMatrix: CorrelationMatrix;
     currencyPowerBalance?: Maybe<Array<CurrencyPowerBalance>>;
     currencyStrength?: Maybe<Array<CurrencyStrength>>;
+    isAllowedPartner?: Maybe<Scalars['Boolean']['output']>;
     mapInstrumentNames?: Maybe<Array<Maybe<Instrument>>>;
+    marginRates?: Maybe<Array<MarginRate>>;
+    orderPositionBook: Array<Maybe<OrderPositionData>>;
     orderPositionBooks: Array<Maybe<OrderPositionData>>;
+    priceCandles: CandlesData;
+    resolveInstrumentsByDivision?: Maybe<Array<Instrument>>;
+    resolveInstrumentsWithFilters?: Maybe<InstrumentTableResult>;
     sentiment?: Maybe<Array<SentimentInstrument>>;
     sentimentList?: Maybe<Array<SentimentInstrument>>;
+    sentiments: SentimentData;
     topicalInstruments?: Maybe<Array<TopicalInstrument>>;
     topicalInstrumentsCharts?: Maybe<Array<TopicalInstrumentChart>>;
     topicalInstrumentsTotalCount: Scalars['Int']['output'];
@@ -204,16 +260,53 @@ export type QueryCorrelationMatrixArgs = {
 export type QueryCurrencyPowerBalanceArgs = {
     timeUnit: CurrencyPowerBalanceTimeUnit;
 };
+export type QueryIsAllowedPartnerArgs = {
+    url: Scalars['String']['input'];
+};
 export type QueryMapInstrumentNamesArgs = {
     division?: InputMaybe<Division>;
     instruments: Array<InputMaybe<Scalars['String']['input']>>;
 };
-export type QueryOrderPositionBooksArgs = {
+export type QueryMarginRatesArgs = {
+    dataSource: DataSource;
+    division: Division;
+    instruments?: InputMaybe<Array<Scalars['String']['input']>>;
+    tradingGroup: Scalars['Int']['input'];
+};
+export type QueryOrderPositionBookArgs = {
     bookType: BookType;
-    dataSource?: InputMaybe<DataSource>;
+    dataSource?: InputMaybe<OrderBookDataSource>;
     instrument: Scalars['String']['input'];
     recentHours?: InputMaybe<Scalars['Int']['input']>;
-    region?: InputMaybe<Region>;
+};
+export type QueryOrderPositionBooksArgs = {
+    bookType: BookType;
+    granularity: Granularity;
+    instrument: Scalars['String']['input'];
+    maxBookPrice?: InputMaybe<Scalars['Float']['input']>;
+    minBookPrice?: InputMaybe<Scalars['Float']['input']>;
+    timeSpan: TimeSpan;
+};
+export type QueryPriceCandlesArgs = {
+    dataSource: DataSource;
+    division: Division;
+    granularity: Granularity;
+    instrument: Scalars['String']['input'];
+    timeSpan: TimeSpan;
+};
+export type QueryResolveInstrumentsByDivisionArgs = {
+    division: Division;
+    instruments: Array<InputMaybe<Scalars['String']['input']>>;
+};
+export type QueryResolveInstrumentsWithFiltersArgs = {
+    assetClass?: InputMaybe<Array<InputMaybe<AssetClassName>>>;
+    count?: InputMaybe<Scalars['Int']['input']>;
+    dataSource: DataSource;
+    division: Division;
+    instruments?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
+    offset?: InputMaybe<Scalars['Int']['input']>;
+    searchPattern?: InputMaybe<Scalars['String']['input']>;
+    tradeModes?: InputMaybe<Array<InputMaybe<TradeMode>>>;
 };
 export type QuerySentimentArgs = {
     division?: InputMaybe<Division>;
@@ -223,6 +316,11 @@ export type QuerySentimentListArgs = {
     division?: InputMaybe<Division>;
     sort?: InputMaybe<Sort>;
 };
+export type QuerySentimentsArgs = {
+    granularity: Granularity;
+    instrument: Scalars['String']['input'];
+    timeSpan: TimeSpan;
+};
 export type QueryTopicalInstrumentsArgs = {
     assetClass?: InputMaybe<AssetClassName>;
     count?: InputMaybe<Scalars['Int']['input']>;
@@ -267,6 +365,10 @@ export type Sentiment = {
     longPercent: Scalars['Float']['output'];
     shortPercent: Scalars['Float']['output'];
 };
+export type SentimentData = {
+    __typename?: 'SentimentData';
+    sentiments: Array<Maybe<SentimentWithTime>>;
+};
 export type SentimentInstrument = {
     __typename?: 'SentimentInstrument';
     displayName: Scalars['String']['output'];
@@ -274,6 +376,11 @@ export type SentimentInstrument = {
     sentiment: Sentiment;
     updatedAt: Scalars['String']['output'];
 };
+export type SentimentWithTime = {
+    __typename?: 'SentimentWithTime';
+    sentiment: Sentiment;
+    time: Scalars['String']['output'];
+};
 export declare enum Sort {
     Bearish = "BEARISH",
     Bullish = "BULLISH"
@@ -288,6 +395,13 @@ export type TimeCorrelation = {
     timeUnit: CorrelationTimeUnit;
     value?: Maybe<Scalars['Float']['output']>;
 };
+export declare enum TimeSpan {
+    FiveDays = "FIVE_DAYS",
+    NinetyDays = "NINETY_DAYS",
+    TenDays = "TEN_DAYS",
+    TwentyDays = "TWENTY_DAYS",
+    TwoDays = "TWO_DAYS"
+}
 export type TopicalInstrument = {
     __typename?: 'TopicalInstrument';
     assetClass?: Maybe<AssetClassName>;
@@ -308,6 +422,14 @@ export declare enum TopicalSort {
     Popular = "POPULAR",
     Volatile = "VOLATILE"
 }
+export declare enum TradeMode {
+    TradeCloseonly = "TRADE_CLOSEONLY",
+    TradeDisabled = "TRADE_DISABLED",
+    TradeFull = "TRADE_FULL",
+    TradeLongonly = "TRADE_LONGONLY",
+    TradeShortonly = "TRADE_SHORTONLY",
+    TradeUndefined = "TRADE_UNDEFINED"
+}
 export declare enum ValueAtRiskBars {
     C100 = "C100",
     C200 = "C200",
@@ -365,14 +487,14 @@ export declare enum VolatilityChartTimeUnit {
     H = "H",
     W = "W"
 }
-export type GetOrderPositionBooksQueryVariables = Exact<{
+export type GetOrderPositionBookQueryVariables = Exact<{
     instrument: Scalars['String']['input'];
     bookType: BookType;
     recentHours?: InputMaybe<Scalars['Int']['input']>;
 }>;
-export type GetOrderPositionBooksQuery = {
+export type GetOrderPositionBookQuery = {
     __typename?: 'Query';
-    orderPositionBooks: Array<{
+    orderPositionBook: Array<{
         __typename?: 'OrderPositionData';
         bucketWidth: number;
         price?: number | null;
@@ -380,9 +502,9 @@ export type GetOrderPositionBooksQuery = {
         buckets: Array<{
             __typename?: 'OrderPositionBucket';
             price: number;
-            longCountPercent: number;
-            shortCountPercent: number;
+            longCountPercent?: number | null;
+            shortCountPercent?: number | null;
         } | null>;
     } | null>;
 };
-export declare const GetOrderPositionBooksDocument: DocumentNode<GetOrderPositionBooksQuery, GetOrderPositionBooksQueryVariables>;
+export declare const GetOrderPositionBookDocument: DocumentNode<GetOrderPositionBookQuery, GetOrderPositionBookQueryVariables>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oanda/labs-order-book-widget",
-  "version": "1.0.226",
+  "version": "1.0.228",
   "description": "Labs Order Book Widget",
   "main": "dist/main/index.js",
   "module": "dist/module/index.js",
@@ -13,7 +13,7 @@
   "author": "OANDA",
   "license": "UNLICENSED",
   "dependencies": {
-    "@oanda/labs-widget-common": "^1.0.226",
+    "@oanda/labs-widget-common": "^1.0.228",
     "@oanda/mono-i18n": "10.0.1",
     "echarts": "6.0.0",
     "echarts-for-react": "3.0.4",
@@ -24,5 +24,5 @@
     "@graphql-codegen/client-preset": "4.1.0",
     "@graphql-codegen/typescript": "4.0.1"
   },
-  "gitHead": "4709e181ae37de87e1c5d5569391c5f6cfeeca33"
+  "gitHead": "8e6597b98667ce51cc5610dddc94f020a2a82908"
 }

package/src/OrderBookWidget/ChartWithData.tsx

@@ -11,10 +11,10 @@ import { useLocale } from '@oanda/mono-i18n';
 import classnames from 'classnames';
 import React from 'react';
 
-import { getOrderPositionBooks } from '../gql/getOrderPositionBooks';
+import { getOrderPositionBook } from '../gql/getOrderPositionBook';
 import type {
-  GetOrderPositionBooksQuery,
-  GetOrderPositionBooksQueryVariables,
+  GetOrderPositionBookQuery,
+  GetOrderPositionBookQueryVariables,
 } from '../gql/types/graphql';
 import { BookType } from '../gql/types/graphql';
 import { Chart } from './components/Chart/Chart';
@@ -27,9 +27,9 @@ const ChartWithData = ({ instrument, bookType }: ChartWithDataProps) => {
   const isDesktop = size === Size.DESKTOP;
 
   const { loading, data, error } = useQuery<
-    GetOrderPositionBooksQuery,
-    GetOrderPositionBooksQueryVariables
-  >(getOrderPositionBooks, {
+    GetOrderPositionBookQuery,
+    GetOrderPositionBookQueryVariables
+  >(getOrderPositionBook, {
     variables: {
       instrument,
       bookType,
@@ -38,8 +38,12 @@ const ChartWithData = ({ instrument, bookType }: ChartWithDataProps) => {
     fetchPolicy: 'network-only',
   });
 
-  const isError = (!loading && !data?.orderPositionBooks[0]?.price) || !!error;
-  const updatedAt = data?.orderPositionBooks[0]?.time;
+  const isError =
+    (!loading &&
+      (!data?.orderPositionBook?.length ||
+        !data?.orderPositionBook[0]?.price)) ||
+    !!error;
+  const updatedAt = data?.orderPositionBook?.[0]?.time;
 
   return (
     <>

package/src/OrderBookWidget/components/Chart/getOption.ts

@@ -25,10 +25,10 @@ export const getOption: GetOptionType = ({
   isDesktop,
   lang,
 }) => {
-  const buckets = data.orderPositionBooks[0]?.buckets || [];
-  const bucketWidth = data.orderPositionBooks[0]?.bucketWidth!;
-  const price = data.orderPositionBooks[0]?.price!;
-  const bucketPrecision = bucketWidth.toString().split('.')[1].length || 0;
+  const buckets = data.orderPositionBook[0]?.buckets || [];
+  const bucketWidth = data.orderPositionBook[0]?.bucketWidth!;
+  const price = data.orderPositionBook[0]?.price!;
+  const bucketPrecision = bucketWidth?.toString().split('.')[1].length || 0;
 
   const dataset = buckets.map((item) => [
     item!.price,

package/src/OrderBookWidget/components/Chart/types.ts

@@ -1,15 +1,15 @@
 import type { EChartsOption } from 'echarts';
 
-import type { GetOrderPositionBooksQuery } from '../../../gql/types/graphql';
+import type { GetOrderPositionBookQuery } from '../../../gql/types/graphql';
 
 export interface ChartProps {
-  data: GetOrderPositionBooksQuery;
+  data: GetOrderPositionBookQuery;
   isOrderBook: boolean;
   precision: number;
 }
 
 export interface GetOptionProps {
-  data: GetOrderPositionBooksQuery;
+  data: GetOrderPositionBookQuery;
   precision: number;
   isDark: boolean;
   isOrderBook: boolean;

package/src/gql/{getOrderPositionBooks.ts → getOrderPositionBook.ts}

@@ -1,12 +1,12 @@
 import { gql } from '@apollo/client';
 
-const getOrderPositionBooks = gql`
-  query GetOrderPositionBooks(
+const getOrderPositionBook = gql`
+  query GetOrderPositionBook(
     $instrument: String!
     $bookType: BookType!
     $recentHours: Int
   ) {
-    orderPositionBooks(
+    orderPositionBook(
       instrument: $instrument
       bookType: $bookType
       recentHours: $recentHours
@@ -23,4 +23,4 @@ const getOrderPositionBooks = gql`
   }
 `;
 
-export { getOrderPositionBooks };
+export { getOrderPositionBook };

package/src/gql/types/gql.ts

@@ -13,8 +13,8 @@ import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/
  * Therefore it is highly recommended to use the babel or swc plugin for production.
  */
 const documents = {
-  '\n  query GetOrderPositionBooks($instrument: String!, $bookType: BookType!, $recentHours: Int) {\n    orderPositionBooks(\n      instrument: $instrument\n      bookType: $bookType\n      recentHours: $recentHours\n    ) {\n      bucketWidth\n      price\n      time\n      buckets {\n        price\n        longCountPercent\n        shortCountPercent\n      }\n    }\n  }\n':
-    types.GetOrderPositionBooksDocument,
+  '\n  query GetOrderPositionBook(\n    $instrument: String!\n    $bookType: BookType!\n    $recentHours: Int\n  ) {\n    orderPositionBook(\n      instrument: $instrument\n      bookType: $bookType\n      recentHours: $recentHours\n    ) {\n      bucketWidth\n      price\n      time\n      buckets {\n        price\n        longCountPercent\n        shortCountPercent\n      }\n    }\n  }\n':
+    types.GetOrderPositionBookDocument,
 };
 
 /**
@@ -35,8 +35,8 @@ export function graphql(source: string): unknown;
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: '\n  query GetOrderPositionBooks($instrument: String!, $bookType: BookType!, $recentHours: Int) {\n    orderPositionBooks(\n      instrument: $instrument\n      bookType: $bookType\n      recentHours: $recentHours\n    ) {\n      bucketWidth\n      price\n      time\n      buckets {\n        price\n        longCountPercent\n        shortCountPercent\n      }\n    }\n  }\n'
-): (typeof documents)['\n  query GetOrderPositionBooks($instrument: String!, $bookType: BookType!, $recentHours: Int) {\n    orderPositionBooks(\n      instrument: $instrument\n      bookType: $bookType\n      recentHours: $recentHours\n    ) {\n      bucketWidth\n      price\n      time\n      buckets {\n        price\n        longCountPercent\n        shortCountPercent\n      }\n    }\n  }\n'];
+  source: '\n  query GetOrderPositionBook(\n    $instrument: String!\n    $bookType: BookType!\n    $recentHours: Int\n  ) {\n    orderPositionBook(\n      instrument: $instrument\n      bookType: $bookType\n      recentHours: $recentHours\n    ) {\n      bucketWidth\n      price\n      time\n      buckets {\n        price\n        longCountPercent\n        shortCountPercent\n      }\n    }\n  }\n'
+): (typeof documents)['\n  query GetOrderPositionBook(\n    $instrument: String!\n    $bookType: BookType!\n    $recentHours: Int\n  ) {\n    orderPositionBook(\n      instrument: $instrument\n      bookType: $bookType\n      recentHours: $recentHours\n    ) {\n      bucketWidth\n      price\n      time\n      buckets {\n        price\n        longCountPercent\n        shortCountPercent\n      }\n    }\n  }\n'];
 
 export function graphql(source: string) {
   return (documents as any)[source] ?? {};