@oanda/labs-crowd-view-widget 1.0.43 → 1.0.45

package/src/gql/types/graphql.ts

@@ -56,14 +56,17 @@ export type Candle = {
   high: Scalars['Float']['output'];
   low: Scalars['Float']['output'];
   open: Scalars['Float']['output'];
+  /** UTC Timestamp */
+  point: Scalars['String']['output'];
 };
 
 export type CandlesData = {
   __typename?: 'CandlesData';
-  candle: Candle;
-  time: Scalars['String']['output'];
+  candle: Array<Maybe<Candle>>;
+  granularity: Granularity;
+  instrument: Instrument;
+  pipsLocation: Scalars['Int']['output'];
   timeSpan: TimeSpan;
-  unixTime: Scalars['Int']['output'];
 };
 
 export type CorrelationHeatmap = {
@@ -133,8 +136,9 @@ export type CurrencyStrength = {
 };
 
 export enum DataSource {
-  Ny4 = 'NY4',
-  Ty3 = 'TY3',
+  All = 'ALL',
+  Mt5 = 'MT5',
+  V20 = 'V20',
 }
 
 export enum Division {
@@ -151,18 +155,17 @@ export enum Division {
 
 export type ExtendedInstrument = {
   __typename?: 'ExtendedInstrument';
+  dataSource: DataSource;
   displayName: Scalars['String']['output'];
   name: Scalars['String']['output'];
   tradeMode: TradeMode;
 };
 
 export enum Granularity {
-  Day_1 = 'DAY_1',
-  Hour_1 = 'HOUR_1',
-  Hour_4 = 'HOUR_4',
-  Minute_5 = 'MINUTE_5',
-  Minute_15 = 'MINUTE_15',
-  Minute_30 = 'MINUTE_30',
+  H1 = 'H1',
+  H4 = 'H4',
+  M5 = 'M5',
+  M15 = 'M15',
 }
 
 export type Heatmap = {
@@ -183,11 +186,6 @@ export type InstrumentCorrelation = {
   value?: Maybe<Scalars['Float']['output']>;
 };
 
-export enum InstrumentDataSource {
-  Mt5 = 'MT5',
-  V20 = 'V20',
-}
-
 export type InstrumentTableResult = {
   __typename?: 'InstrumentTableResult';
   instruments: Array<ExtendedInstrument>;
@@ -195,17 +193,30 @@ export type InstrumentTableResult = {
   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 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 = {
@@ -227,10 +238,12 @@ export type Query = {
   correlationMatrix: CorrelationMatrix;
   currencyPowerBalance?: Maybe<Array<CurrencyPowerBalance>>;
   currencyStrength?: Maybe<Array<CurrencyStrength>>;
-  getPriceCandles: Array<CandlesData>;
   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>>;
@@ -263,13 +276,6 @@ export type QueryCurrencyPowerBalanceArgs = {
   timeUnit: CurrencyPowerBalanceTimeUnit;
 };
 
-export type QueryGetPriceCandlesArgs = {
-  division?: InputMaybe<Division>;
-  granularity: Granularity;
-  instrument: Scalars['String']['input'];
-  timeSpan: TimeSpan;
-};
-
 export type QueryIsAllowedPartnerArgs = {
   url: Scalars['String']['input'];
 };
@@ -279,12 +285,35 @@ export type QueryMapInstrumentNamesArgs = {
   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 = {
@@ -295,7 +324,7 @@ export type QueryResolveInstrumentsByDivisionArgs = {
 export type QueryResolveInstrumentsWithFiltersArgs = {
   assetClass?: InputMaybe<Array<InputMaybe<AssetClassName>>>;
   count?: InputMaybe<Scalars['Int']['input']>;
-  dataSource?: InputMaybe<InstrumentDataSource>;
+  dataSource: DataSource;
   division: Division;
   instruments?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
   offset?: InputMaybe<Scalars['Int']['input']>;
@@ -392,17 +421,11 @@ export type TimeCorrelation = {
 };
 
 export enum TimeSpan {
-  Day_1 = 'DAY_1',
-  Day_2 = 'DAY_2',
-  Hour_1 = 'HOUR_1',
-  Hour_12 = 'HOUR_12',
-  Month_1 = 'MONTH_1',
-  Month_3 = 'MONTH_3',
-  Month_6 = 'MONTH_6',
-  Week_1 = 'WEEK_1',
-  Week_2 = 'WEEK_2',
-  Week_3 = 'WEEK_3',
-  Year_1 = 'YEAR_1',
+  FiveDays = 'FIVE_DAYS',
+  NinetyDays = 'NINETY_DAYS',
+  TenDays = 'TEN_DAYS',
+  TwentyDays = 'TWENTY_DAYS',
+  TwoDays = 'TWO_DAYS',
 }
 
 export type TopicalInstrument = {
@@ -505,7 +528,10 @@ export enum VolatilityChartTimeUnit {
 export type GetOrderPositionBooksQueryVariables = Exact<{
   instrument: Scalars['String']['input'];
   bookType: BookType;
-  recentHours?: InputMaybe<Scalars['Int']['input']>;
+  timeSpan: TimeSpan;
+  granularity: Granularity;
+  maxBookPrice?: InputMaybe<Scalars['Float']['input']>;
+  minBookPrice?: InputMaybe<Scalars['Float']['input']>;
 }>;
 
 export type GetOrderPositionBooksQuery = {
@@ -518,14 +544,14 @@ export type GetOrderPositionBooksQuery = {
     buckets: Array<{
       __typename?: 'OrderPositionBucket';
       price: number;
-      longCountPercent: number;
-      shortCountPercent: number;
+      sentiment?: number | null;
     } | null>;
   } | null>;
 };
 
 export type GetPriceCandlesQueryVariables = Exact<{
-  division?: InputMaybe<Division>;
+  dataSource: DataSource;
+  division: Division;
   instrument: Scalars['String']['input'];
   granularity: Granularity;
   timeSpan: TimeSpan;
@@ -533,35 +559,17 @@ export type GetPriceCandlesQueryVariables = Exact<{
 
 export type GetPriceCandlesQuery = {
   __typename?: 'Query';
-  getPriceCandles: Array<{
+  priceCandles: {
     __typename?: 'CandlesData';
-    time: string;
-    unixTime: number;
-    timeSpan: TimeSpan;
-    candle: {
+    candle: Array<{
       __typename?: 'Candle';
+      point: string;
       high: number;
       low: number;
       open: number;
       close: number;
-    };
-  }>;
-};
-
-export type ValidateInstrumentsQueryVariables = Exact<{
-  instruments:
-    | Array<InputMaybe<Scalars['String']['input']>>
-    | InputMaybe<Scalars['String']['input']>;
-  division?: InputMaybe<Division>;
-}>;
-
-export type ValidateInstrumentsQuery = {
-  __typename?: 'Query';
-  mapInstrumentNames?: Array<{
-    __typename?: 'Instrument';
-    name: string;
-    displayName: string;
-  } | null> | null;
+    } | null>;
+  };
 };
 
 export const GetOrderPositionBooksDocument = {
@@ -604,9 +612,45 @@ export const GetOrderPositionBooksDocument = {
           kind: 'VariableDefinition',
           variable: {
             kind: 'Variable',
-            name: { kind: 'Name', value: 'recentHours' },
+            name: { kind: 'Name', value: 'timeSpan' },
+          },
+          type: {
+            kind: 'NonNullType',
+            type: {
+              kind: 'NamedType',
+              name: { kind: 'Name', value: 'TimeSpan' },
+            },
           },
-          type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: {
+            kind: 'Variable',
+            name: { kind: 'Name', value: 'granularity' },
+          },
+          type: {
+            kind: 'NonNullType',
+            type: {
+              kind: 'NamedType',
+              name: { kind: 'Name', value: 'Granularity' },
+            },
+          },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: {
+            kind: 'Variable',
+            name: { kind: 'Name', value: 'maxBookPrice' },
+          },
+          type: { kind: 'NamedType', name: { kind: 'Name', value: 'Float' } },
+        },
+        {
+          kind: 'VariableDefinition',
+          variable: {
+            kind: 'Variable',
+            name: { kind: 'Name', value: 'minBookPrice' },
+          },
+          type: { kind: 'NamedType', name: { kind: 'Name', value: 'Float' } },
         },
       ],
       selectionSet: {
@@ -634,10 +678,34 @@ export const GetOrderPositionBooksDocument = {
               },
               {
                 kind: 'Argument',
-                name: { kind: 'Name', value: 'recentHours' },
+                name: { kind: 'Name', value: 'timeSpan' },
+                value: {
+                  kind: 'Variable',
+                  name: { kind: 'Name', value: 'timeSpan' },
+                },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'granularity' },
+                value: {
+                  kind: 'Variable',
+                  name: { kind: 'Name', value: 'granularity' },
+                },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'maxBookPrice' },
+                value: {
+                  kind: 'Variable',
+                  name: { kind: 'Name', value: 'maxBookPrice' },
+                },
+              },
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'minBookPrice' },
                 value: {
                   kind: 'Variable',
-                  name: { kind: 'Name', value: 'recentHours' },
+                  name: { kind: 'Name', value: 'minBookPrice' },
                 },
               },
             ],
@@ -656,11 +724,7 @@ export const GetOrderPositionBooksDocument = {
                       { kind: 'Field', name: { kind: 'Name', value: 'price' } },
                       {
                         kind: 'Field',
-                        name: { kind: 'Name', value: 'longCountPercent' },
-                      },
-                      {
-                        kind: 'Field',
-                        name: { kind: 'Name', value: 'shortCountPercent' },
+                        name: { kind: 'Name', value: 'sentiment' },
                       },
                     ],
                   },
@@ -684,6 +748,20 @@ export const GetPriceCandlesDocument = {
       operation: 'query',
       name: { kind: 'Name', value: 'GetPriceCandles' },
       variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: {
+            kind: 'Variable',
+            name: { kind: 'Name', value: 'dataSource' },
+          },
+          type: {
+            kind: 'NonNullType',
+            type: {
+              kind: 'NamedType',
+              name: { kind: 'Name', value: 'DataSource' },
+            },
+          },
+        },
         {
           kind: 'VariableDefinition',
           variable: {
@@ -691,8 +769,11 @@ export const GetPriceCandlesDocument = {
             name: { kind: 'Name', value: 'division' },
           },
           type: {
-            kind: 'NamedType',
-            name: { kind: 'Name', value: 'Division' },
+            kind: 'NonNullType',
+            type: {
+              kind: 'NamedType',
+              name: { kind: 'Name', value: 'Division' },
+            },
           },
         },
         {
@@ -743,8 +824,16 @@ export const GetPriceCandlesDocument = {
         selections: [
           {
             kind: 'Field',
-            name: { kind: 'Name', value: 'getPriceCandles' },
+            name: { kind: 'Name', value: 'priceCandles' },
             arguments: [
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'dataSource' },
+                value: {
+                  kind: 'Variable',
+                  name: { kind: 'Name', value: 'dataSource' },
+                },
+              },
               {
                 kind: 'Argument',
                 name: { kind: 'Name', value: 'division' },
@@ -781,14 +870,13 @@ export const GetPriceCandlesDocument = {
             selectionSet: {
               kind: 'SelectionSet',
               selections: [
-                { kind: 'Field', name: { kind: 'Name', value: 'time' } },
-                { kind: 'Field', name: { kind: 'Name', value: 'unixTime' } },
                 {
                   kind: 'Field',
                   name: { kind: 'Name', value: 'candle' },
                   selectionSet: {
                     kind: 'SelectionSet',
                     selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'point' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'high' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'low' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'open' } },
@@ -796,7 +884,6 @@ export const GetPriceCandlesDocument = {
                     ],
                   },
                 },
-                { kind: 'Field', name: { kind: 'Name', value: 'timeSpan' } },
               ],
             },
           },
@@ -808,80 +895,3 @@ export const GetPriceCandlesDocument = {
   GetPriceCandlesQuery,
   GetPriceCandlesQueryVariables
 >;
-export const ValidateInstrumentsDocument = {
-  kind: 'Document',
-  definitions: [
-    {
-      kind: 'OperationDefinition',
-      operation: 'query',
-      name: { kind: 'Name', value: 'validateInstruments' },
-      variableDefinitions: [
-        {
-          kind: 'VariableDefinition',
-          variable: {
-            kind: 'Variable',
-            name: { kind: 'Name', value: 'instruments' },
-          },
-          type: {
-            kind: 'NonNullType',
-            type: {
-              kind: 'ListType',
-              type: {
-                kind: 'NamedType',
-                name: { kind: 'Name', value: 'String' },
-              },
-            },
-          },
-        },
-        {
-          kind: 'VariableDefinition',
-          variable: {
-            kind: 'Variable',
-            name: { kind: 'Name', value: 'division' },
-          },
-          type: {
-            kind: 'NamedType',
-            name: { kind: 'Name', value: 'Division' },
-          },
-        },
-      ],
-      selectionSet: {
-        kind: 'SelectionSet',
-        selections: [
-          {
-            kind: 'Field',
-            name: { kind: 'Name', value: 'mapInstrumentNames' },
-            arguments: [
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'instruments' },
-                value: {
-                  kind: 'Variable',
-                  name: { kind: 'Name', value: 'instruments' },
-                },
-              },
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'division' },
-                value: {
-                  kind: 'Variable',
-                  name: { kind: 'Name', value: 'division' },
-                },
-              },
-            ],
-            selectionSet: {
-              kind: 'SelectionSet',
-              selections: [
-                { kind: 'Field', name: { kind: 'Name', value: 'name' } },
-                { kind: 'Field', name: { kind: 'Name', value: 'displayName' } },
-              ],
-            },
-          },
-        ],
-      },
-    },
-  ],
-} as unknown as DocumentNode<
-  ValidateInstrumentsQuery,
-  ValidateInstrumentsQueryVariables
->;

package/src/translations/sources/en.json

@@ -1,2 +1,26 @@
 {
+  "data_unavailable": "Data unavailable",
+  "no_matching_results": "No matching results",
+  "pagination_entries_range": "{{firstItemOnPage}}-{{lastItemOnPage}} of {{itemCount}} entries",
+  "order_book": "Order book",
+  "position_book": "Position book",
+  "long": "Long",
+  "short": "Short",
+  "instrument": "Instrument",
+  "granularity": "Granularity",
+  "search": "Search",
+  "5_minutes": "5 minutes",
+  "15_minutes": "15 minutes",
+  "1_hour": "1 hour",
+  "4_hours": "4 hours",
+  "candle": "Candle",
+  "open_price": "Open price",
+  "close_price": "Close price",
+  "low": "Low",
+  "high": "High",
+  "orders": "Orders",
+  "price_range": "Price range",
+  "sentiment": "Sentiment",
+  "buy_advantage": "Buy advantage",
+  "sell_advantage": "Sell advantage"
 }

package/test/Main.test.tsx

@@ -6,49 +6,95 @@ import { MockLayoutProvider } from '@oanda/labs-widget-common';
 import { render } from '@testing-library/react';
 import React from 'react';
 
-import { InstrumentId } from '../src';
 import { Main } from '../src/CrowdViewWidget/Main';
+import { InstrumentId } from '../src/CrowdViewWidget/types/instruments';
 import { getOrderPositionBooks } from '../src/gql/getOrderPositionBooks';
-import { BookType, Division } from '../src/gql/types/graphql';
+import { getPriceCandles } from '../src/gql/getPriceCandles';
+import {
+  BookType,
+  DataSource,
+  Division,
+  Granularity,
+  TimeSpan,
+} from '../src/gql/types/graphql';
+
+const instrument = InstrumentId.EUR_AUD;
+const division = Division.Oap;
+const granularity = Granularity.H4;
+const timeSpan = TimeSpan.NinetyDays;
+
+const candles = [
+  {
+    point: '2024-02-21T10:00:00Z',
+    high: 1.334,
+    low: 1.33,
+    open: 1.331,
+    close: 1.333,
+  },
+  {
+    point: '2024-02-21T10:30:00Z',
+    high: 1.335,
+    low: 1.3295,
+    open: 1.33,
+    close: 1.334,
+  },
+  {
+    point: '2024-02-21T11:00:00Z',
+    high: 1.333,
+    low: 1.329,
+    open: 1.331,
+    close: 1.332,
+  },
+];
+
+const maxPrice = 1.335;
+const minPrice = 1.329;
+const bucketWidth = 0.0005;
+const maxBookPrice = maxPrice + bucketWidth * 2;
+const minBookPrice = minPrice - bucketWidth * 2;
 
 const mocks = [
+  {
+    request: {
+      query: getPriceCandles,
+      variables: {
+        dataSource: DataSource.Mt5,
+        division,
+        instrument,
+        granularity,
+        timeSpan,
+      },
+    },
+    result: {
+      data: {
+        priceCandles: {
+          candle: candles,
+        },
+      },
+    },
+  },
   {
     request: {
       query: getOrderPositionBooks,
       variables: {
-        instrument: InstrumentId.EUR_AUD,
+        instrument,
         bookType: BookType.Order,
-        recentHours: 1,
+        timeSpan,
+        granularity,
+        maxBookPrice,
+        minBookPrice,
       },
     },
     result: {
       data: {
         orderPositionBooks: [
           {
-            bucketWidth: 0.0005,
-            price: 0.8,
+            bucketWidth,
+            price: maxPrice,
             time: '2024-02-21T10:30:00Z',
             buckets: [
-              {
-                price: 0.02,
-                longCountPercent: 0.0582,
-                shortCountPercent: 0.0,
-              },
-              {
-                price: 0.7,
-                longCountPercent: 0.0582,
-                shortCountPercent: 0.0,
-              },
-              {
-                price: 0.9925,
-                longCountPercent: 0.0582,
-                shortCountPercent: 0.0,
-              },
-              {
-                price: 1.0,
-                longCountPercent: 0.1163,
-                shortCountPercent: 0.0,
-              },
+              { price: 1.3345, sentiment: 0.2 },
+              { price: 1.3305, sentiment: -0.3 },
             ],
           },
         ],
@@ -62,7 +108,7 @@ describe('Main component', () => {
     const { findByTestId } = render(
       <MockedProvider mocks={mocks}>
         <MockLayoutProvider>
-          <Main division={Division.Oap} />
+          <Main division={division} />
         </MockLayoutProvider>
       </MockedProvider>
     );