@oanda/labs-spread-cost-calculator-widget 1.0.6 → 1.0.8

package/src/gql/types/gql.ts

@@ -13,7 +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 validateInstruments($instruments: [String]!, $division: Division) {\n    mapInstrumentNames(instruments: $instruments, division: $division) {\n      name\n      displayName\n    }\n  }\n": types.ValidateInstrumentsDocument,
+  '\n  query validateInstruments($instruments: [String]!, $division: Division) {\n    mapInstrumentNames(instruments: $instruments, division: $division) {\n      name\n      displayName\n    }\n  }\n':
+    types.ValidateInstrumentsDocument,
 };
 
 /**
@@ -33,10 +34,13 @@ 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 validateInstruments($instruments: [String]!, $division: Division) {\n    mapInstrumentNames(instruments: $instruments, division: $division) {\n      name\n      displayName\n    }\n  }\n"): (typeof documents)["\n  query validateInstruments($instruments: [String]!, $division: Division) {\n    mapInstrumentNames(instruments: $instruments, division: $division) {\n      name\n      displayName\n    }\n  }\n"];
+export function graphql(
+  source: '\n  query validateInstruments($instruments: [String]!, $division: Division) {\n    mapInstrumentNames(instruments: $instruments, division: $division) {\n      name\n      displayName\n    }\n  }\n'
+): (typeof documents)['\n  query validateInstruments($instruments: [String]!, $division: Division) {\n    mapInstrumentNames(instruments: $instruments, division: $division) {\n      name\n      displayName\n    }\n  }\n'];
 
 export function graphql(source: string) {
   return (documents as any)[source] ?? {};
 }
 
-export type DocumentType<TDocumentNode extends DocumentNode<any, any>> = TDocumentNode extends DocumentNode<  infer TType,  any>  ? TType  : never;
+export type DocumentType<TDocumentNode extends DocumentNode<any, any>> =
+  TDocumentNode extends DocumentNode<infer TType, any> ? TType : never;

package/src/gql/types/graphql.ts

@@ -2,18 +2,31 @@
 import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
-export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
-export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
-export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
-export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
-export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+export type Exact<T extends { [key: string]: unknown }> = {
+  [K in keyof T]: T[K];
+};
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
+  [SubKey in K]?: Maybe<T[SubKey]>;
+};
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
+  [SubKey in K]: Maybe<T[SubKey]>;
+};
+export type MakeEmpty<
+  T extends { [key: string]: unknown },
+  K extends keyof T,
+> = { [_ in K]?: never };
+export type Incremental<T> =
+  | T
+  | {
+      [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
+    };
 /** All built-in and custom scalars, mapped to their actual values */
 export type Scalars = {
-  ID: { input: string; output: string; }
-  String: { input: string; output: string; }
-  Boolean: { input: boolean; output: boolean; }
-  Int: { input: number; output: number; }
-  Float: { input: number; output: number; }
+  ID: { input: string; output: string };
+  String: { input: string; output: string };
+  Boolean: { input: boolean; output: boolean };
+  Int: { input: number; output: number };
+  Float: { input: number; output: number };
 };
 
 export type AssetClass = {
@@ -28,12 +41,12 @@ export enum AssetClassName {
   Currency = 'CURRENCY',
   EquityShares = 'EQUITY_SHARES',
   Indices = 'INDICES',
-  Rates = 'RATES'
+  Rates = 'RATES',
 }
 
 export enum BookType {
   Order = 'ORDER',
-  Position = 'POSITION'
+  Position = 'POSITION',
 }
 
 export type CorrelationHeatmap = {
@@ -56,7 +69,7 @@ export enum CorrelationTimeUnit {
   M3 = 'M3',
   M6 = 'M6',
   W1 = 'W1',
-  Y1 = 'Y1'
+  Y1 = 'Y1',
 }
 
 export enum CurrencyName {
@@ -67,7 +80,7 @@ export enum CurrencyName {
   Gbp = 'GBP',
   Jpy = 'JPY',
   Nzd = 'NZD',
-  Usd = 'USD'
+  Usd = 'USD',
 }
 
 export type CurrencyPower = {
@@ -92,7 +105,7 @@ export enum CurrencyPowerBalanceTimeUnit {
   M1 = 'M1',
   M3 = 'M3',
   PreviousDay = 'PREVIOUS_DAY',
-  W1 = 'W1'
+  W1 = 'W1',
 }
 
 export type CurrencyStrength = {
@@ -104,7 +117,7 @@ export type CurrencyStrength = {
 
 export enum DataSource {
   Ny4 = 'NY4',
-  Ty3 = 'TY3'
+  Ty3 = 'TY3',
 }
 
 export enum Division {
@@ -116,7 +129,7 @@ export enum Division {
   Ogm = 'OGM',
   Oj = 'OJ',
   Opt = 'OPT',
-  Otms = 'OTMS'
+  Otms = 'OTMS',
 }
 
 export type Heatmap = {
@@ -184,41 +197,34 @@ export type Query = {
   volatilityChartAssetClasses?: Maybe<Array<AssetClass>>;
 };
 
-
 export type QueryAssetClassesArgs = {
   division: Division;
 };
 
-
 export type QueryCorrelationHeatmapArgs = {
   division: Division;
   instruments?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
   timeSpans?: InputMaybe<Array<InputMaybe<CorrelationTimeUnit>>>;
 };
 
-
 export type QueryCorrelationMatrixArgs = {
   division: Division;
   instruments?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
 };
 
-
 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 = {
   bookType: BookType;
   dataSource?: InputMaybe<DataSource>;
@@ -227,25 +233,21 @@ export type QueryOrderPositionBooksArgs = {
   region?: InputMaybe<Region>;
 };
 
-
 export type QueryResolveInstrumentsByDivisionArgs = {
   division: Division;
   instruments: Array<InputMaybe<Scalars['String']['input']>>;
 };
 
-
 export type QuerySentimentArgs = {
   division?: InputMaybe<Division>;
   name: Scalars['String']['input'];
 };
 
-
 export type QuerySentimentListArgs = {
   division?: InputMaybe<Division>;
   sort?: InputMaybe<Sort>;
 };
 
-
 export type QueryTopicalInstrumentsArgs = {
   assetClass?: InputMaybe<AssetClassName>;
   count?: InputMaybe<Scalars['Int']['input']>;
@@ -254,25 +256,21 @@ export type QueryTopicalInstrumentsArgs = {
   sort: TopicalSort;
 };
 
-
 export type QueryTopicalInstrumentsChartsArgs = {
   division?: InputMaybe<Division>;
   instruments?: InputMaybe<Array<Scalars['String']['input']>>;
 };
 
-
 export type QueryTopicalInstrumentsTotalCountArgs = {
   assetClass?: InputMaybe<AssetClassName>;
   division?: InputMaybe<Division>;
   sort: TopicalSort;
 };
 
-
 export type QueryValueAtRiskAssetClassesArgs = {
   division?: InputMaybe<Division>;
 };
 
-
 export type QueryValueAtRiskChartArgs = {
   bars: ValueAtRiskBars;
   division?: InputMaybe<Division>;
@@ -280,7 +278,6 @@ export type QueryValueAtRiskChartArgs = {
   instrument: Scalars['String']['input'];
 };
 
-
 export type QueryVolatilityChartArgs = {
   division?: InputMaybe<Division>;
   instrument: Scalars['String']['input'];
@@ -288,7 +285,6 @@ export type QueryVolatilityChartArgs = {
   timeUnit: VolatilityChartTimeUnit;
 };
 
-
 export type QueryVolatilityChartAssetClassesArgs = {
   division?: InputMaybe<Division>;
 };
@@ -296,7 +292,7 @@ export type QueryVolatilityChartAssetClassesArgs = {
 export enum Region {
   Amer = 'AMER',
   Apac = 'APAC',
-  Emea = 'EMEA'
+  Emea = 'EMEA',
 }
 
 export type Sentiment = {
@@ -315,7 +311,7 @@ export type SentimentInstrument = {
 
 export enum Sort {
   Bearish = 'BEARISH',
-  Bullish = 'BULLISH'
+  Bullish = 'BULLISH',
 }
 
 export type StrengthRelation = {
@@ -350,13 +346,13 @@ export enum TopicalSort {
   Bullish = 'BULLISH',
   Hot = 'HOT',
   Popular = 'POPULAR',
-  Volatile = 'VOLATILE'
+  Volatile = 'VOLATILE',
 }
 
 export enum ValueAtRiskBars {
   C100 = 'C100',
   C200 = 'C200',
-  C300 = 'C300'
+  C300 = 'C300',
 }
 
 export type ValueAtRiskChart = {
@@ -386,7 +382,7 @@ export enum ValueAtRiskDuration {
   C3 = 'C3',
   C4 = 'C4',
   C5 = 'C5',
-  C10 = 'C10'
+  C10 = 'C10',
 }
 
 export type VolatilityChart = {
@@ -409,22 +405,105 @@ export enum VolatilityChartTimeSpan {
   /**  Valid for: W */
   W5 = 'W5',
   /**  Valid for: W */
-  W10 = 'W10'
+  W10 = 'W10',
 }
 
 export enum VolatilityChartTimeUnit {
   D = 'D',
   H = 'H',
-  W = 'W'
+  W = 'W',
 }
 
 export type ValidateInstrumentsQueryVariables = Exact<{
-  instruments: Array<InputMaybe<Scalars['String']['input']>> | InputMaybe<Scalars['String']['input']>;
+  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 };
-
-
-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>;
+export type ValidateInstrumentsQuery = {
+  __typename?: 'Query';
+  mapInstrumentNames?: Array<{
+    __typename?: 'Instrument';
+    name: string;
+    displayName: string;
+  } | null> | null;
+};
+
+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/gql/types/index.ts

@@ -1,2 +1,2 @@
-export * from "./fragment-masking";
-export * from "./gql";
+export * from './fragment-masking';
+export * from './gql';

package/src/index.ts

@@ -1,2 +1,2 @@
-export * from './SpreadCostCalculatorWidget/types';
 export * from './SpreadCostCalculatorWidget/SpreadCostCalculatorWidget';
+export * from './SpreadCostCalculatorWidget/types';

package/src/translations/index.ts

@@ -1,11 +1,11 @@
-import { Locale, Translations } from '@oanda/mono-i18n';
+import type { Translations } from '@oanda/mono-i18n';
+import { Locale } from '@oanda/mono-i18n';
 
 import en from './sources/en.json';
-import zhTW from './sources/zh_TW.json';
 import es from './sources/es.json';
 import th from './sources/th.json';
-
-import { defaultTranslations } from './translations';
+import zhTW from './sources/zh_TW.json';
+import type { defaultTranslations } from './translations';
 
 export type TranslationKey = keyof typeof defaultTranslations;
 

package/test/SpreadCostCalculator.test.tsx

@@ -2,11 +2,13 @@
  * @jest-environment jsdom
  */
 
-/* eslint-disable react/jsx-props-no-spreading */
-
-import React from 'react';
+import {
+  LiveRatesProvider,
+  MockLayoutProvider,
+} from '@oanda/labs-widget-common';
 import { render } from '@testing-library/react';
-import { LiveRatesProvider, MockLayoutProvider } from '@oanda/labs-widget-common';
+import React from 'react';
+
 import { Main } from '../src/SpreadCostCalculatorWidget/Main';
 
 describe('Spread Cost Calculator', () => {
@@ -23,11 +25,9 @@ describe('Spread Cost Calculator', () => {
     const { findByTestId } = render(
       <LiveRatesProvider url="oanda.com">
         <MockLayoutProvider>
-          <Main
-            instruments={[{ name: 'EUR_USD', displayName: 'EUR/USD' }]}
-          />
+          <Main instruments={[{ name: 'EUR_USD', displayName: 'EUR/USD' }]} />
         </MockLayoutProvider>
-      </LiveRatesProvider>,
+      </LiveRatesProvider>
     );
 
     // Then

package/test/useCalculateSpread.test.tsx

@@ -3,10 +3,9 @@
  */
 
 import { act, renderHook } from '@testing-library/react';
-import {
-  useCalculateSpread,
-  UseCalculateSpreadInput,
-} from '../src/SpreadCostCalculatorWidget/useCalculateSpread';
+
+import type { UseCalculateSpreadInput } from '../src/SpreadCostCalculatorWidget/useCalculateSpread';
+import { useCalculateSpread } from '../src/SpreadCostCalculatorWidget/useCalculateSpread';
 
 describe('spread cost calculator', () => {
   describe('useCalculateSpread', () => {
@@ -33,17 +32,17 @@ describe('spread cost calculator', () => {
       { ...input, pipLocation: undefined },
     ])(
       'should return undefined, when one of params is undefined (%s)',
-      ({
-        unitsTraded, spread, pipLocation, currency,
-      }) => {
+      ({ unitsTraded, spread, pipLocation, currency }) => {
         // Given
         // When
-        const { result } = renderHook(() => useCalculateSpread({
-          spread,
-          unitsTraded,
-          pipLocation,
-          currency,
-        }));
+        const { result } = renderHook(() =>
+          useCalculateSpread({
+            spread,
+            unitsTraded,
+            pipLocation,
+            currency,
+          })
+        );
 
         expect(result.current).toBe('\u2014');
 
@@ -53,17 +52,19 @@ describe('spread cost calculator', () => {
 
         // Then
         expect(result.current).toBe('\u2014');
-      },
+      }
     );
 
     it('should return correct calculated values', () => {
       // Given
       // When
-      const { result } = renderHook(() => useCalculateSpread({
-        ...input,
-        spread: 2,
-        pipLocation: -4,
-      }));
+      const { result } = renderHook(() =>
+        useCalculateSpread({
+          ...input,
+          spread: 2,
+          pipLocation: -4,
+        })
+      );
 
       expect(result.current).toBe('\u2014');
 
@@ -78,11 +79,13 @@ describe('spread cost calculator', () => {
     it('should return correct calculated values with 0 as pipLocation', () => {
       // Given
       // When
-      const { result } = renderHook(() => useCalculateSpread({
-        ...input,
-        spread: 2,
-        pipLocation: 0,
-      }));
+      const { result } = renderHook(() =>
+        useCalculateSpread({
+          ...input,
+          spread: 2,
+          pipLocation: 0,
+        })
+      );
 
       expect(result.current).toBe('\u2014');
 
@@ -97,11 +100,13 @@ describe('spread cost calculator', () => {
     it('should round up result to 4 decimal places', () => {
       // Given
       // When
-      const { result } = renderHook(() => useCalculateSpread({
-        ...input,
-        unitsTraded: 4,
-        spread: 1.1,
-      }));
+      const { result } = renderHook(() =>
+        useCalculateSpread({
+          ...input,
+          unitsTraded: 4,
+          spread: 1.1,
+        })
+      );
 
       expect(result.current).toBe('\u2014');
 
@@ -116,11 +121,13 @@ describe('spread cost calculator', () => {
     it('should calculate big numbers', () => {
       // Given
       // When
-      const { result } = renderHook(() => useCalculateSpread({
-        ...input,
-        unitsTraded: 1122342,
-        spread: 123331,
-      }));
+      const { result } = renderHook(() =>
+        useCalculateSpread({
+          ...input,
+          unitsTraded: 1122342,
+          spread: 123331,
+        })
+      );
 
       expect(result.current).toBe('\u2014');
 

package/test/useInstrumentChange.test.tsx

@@ -2,12 +2,15 @@
  * @jest-environment jsdom
  */
 
+import {
+  useLiveRatesMessage,
+  useLiveRatesQuery,
+} from '@oanda/labs-widget-common';
 import { renderHook } from '@testing-library/react';
-import { useLiveRatesMessage, useLiveRatesQuery } from '@oanda/labs-widget-common';
+
 import { useInstrumentChange } from '../src/SpreadCostCalculatorWidget/useInstrumentChange';
 
 jest.mock('@oanda/labs-widget-common', () => ({
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   ...jest.requireActual('@oanda/labs-widget-common'),
   useLiveRatesQuery: jest.fn(),
   useLiveRatesMessage: jest.fn(),
@@ -26,7 +29,9 @@ describe('useInstrumentChange', () => {
       update: undefined,
     });
 
-    const { result } = renderHook(() => useInstrumentChange({ initialInstrument }));
+    const { result } = renderHook(() =>
+      useInstrumentChange({ initialInstrument })
+    );
 
     expect(result.current.selectedInstrument).toEqual(initialInstrument);
     expect(result.current.pipLocation).toBe(undefined);
@@ -46,7 +51,9 @@ describe('useInstrumentChange', () => {
       update: updateMock,
     });
 
-    const { result } = renderHook(() => useInstrumentChange({ initialInstrument }));
+    const { result } = renderHook(() =>
+      useInstrumentChange({ initialInstrument })
+    );
 
     expect(result.current.pipLocation).toBe(-4);
     expect(result.current.initialSpread).toBe(1.2);