@oanda/labs-crowd-view-widget 1.0.44 → 1.0.46

package/test/utils/validateData.test.ts

@@ -0,0 +1,201 @@
+import { validateData } from '../../src/CrowdViewWidget/components';
+import type {
+  GetOrderPositionBooksQuery,
+  GetPriceCandlesQuery,
+} from '../../src/gql/types/graphql';
+
+describe('validateData', () => {
+  const createMockPriceCandlesData = (
+    candles?: Array<{
+      point: string;
+      high: number;
+      low: number;
+      open: number;
+      close: number;
+    } | null>
+  ): GetPriceCandlesQuery => ({
+    priceCandles: {
+      candle:
+        candles !== undefined
+          ? candles
+          : [
+              {
+                point: '2025-01-01T00:00:00Z',
+                high: 1.5,
+                low: 1.0,
+                open: 1.2,
+                close: 1.3,
+              },
+            ],
+    },
+  });
+
+  const createMockOrderPositionData = (
+    books?: Array<{
+      bucketWidth: number;
+      price?: number | null;
+      time: string;
+      buckets: Array<{ price: number; sentiment: number }>;
+    } | null>
+  ): GetOrderPositionBooksQuery => ({
+    orderPositionBooks:
+      books !== undefined
+        ? books
+        : [
+            {
+              bucketWidth: 0.0005,
+              price: 1.0,
+              time: '2025-01-01',
+              buckets: [{ price: 1.0, sentiment: 0.2 }],
+            },
+          ],
+  });
+
+  it('should return null when all data is valid', () => {
+    const priceCandlesData = createMockPriceCandlesData();
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    expect(result).toBeNull();
+  });
+
+  it('should return error when priceCandlesData is undefined', () => {
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(undefined, orderPositionData, true);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient price candle data');
+  });
+
+  it('should return error when priceCandles is undefined', () => {
+    const priceCandlesData: GetPriceCandlesQuery = {
+      priceCandles: {} as any,
+    };
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient price candle data');
+  });
+
+  it('should return error when candle array is empty', () => {
+    const priceCandlesData = createMockPriceCandlesData([]);
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient price candle data');
+  });
+
+  it('should not return error when candle array has null values but length >= 1', () => {
+    // validateData only checks array length, not content validity
+    // An array with nulls has length > 0, so it passes the length check
+    // The hasValidCandles parameter handles content validation
+    const priceCandlesData = createMockPriceCandlesData([null, null]);
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    // Array length >= 1, so it passes length check, but hasValidCandles should be false
+    expect(result).toBeNull();
+  });
+
+  it('should return error when orderPositionData is undefined', () => {
+    const priceCandlesData = createMockPriceCandlesData();
+    const result = validateData(priceCandlesData, undefined, true);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient order position data');
+  });
+
+  it('should return error when orderPositionBooks is empty', () => {
+    const priceCandlesData = createMockPriceCandlesData();
+    const orderPositionData: GetOrderPositionBooksQuery = {
+      orderPositionBooks: [],
+    };
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient order position data');
+  });
+
+  it('should return error when hasValidCandles is false', () => {
+    const priceCandlesData = createMockPriceCandlesData();
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(priceCandlesData, orderPositionData, false);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Invalid candle data');
+  });
+
+  it('should prioritize price candle error over order position error', () => {
+    const orderPositionData: GetOrderPositionBooksQuery = {
+      orderPositionBooks: [],
+    };
+    const result = validateData(undefined, orderPositionData, true);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient price candle data');
+  });
+
+  it('should prioritize price candle error over hasValidCandles error', () => {
+    const orderPositionData = createMockOrderPositionData();
+    const result = validateData(undefined, orderPositionData, false);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient price candle data');
+  });
+
+  it('should prioritize order position error over hasValidCandles error', () => {
+    const priceCandlesData = createMockPriceCandlesData();
+    const result = validateData(priceCandlesData, undefined, false);
+    expect(result).toBeInstanceOf(Error);
+    expect(result?.message).toBe('Insufficient order position data');
+  });
+
+  it('should accept data with minimum required candles (1)', () => {
+    const priceCandlesData = createMockPriceCandlesData([
+      {
+        point: '2025-01-01T00:00:00Z',
+        high: 1.5,
+        low: 1.0,
+        open: 1.2,
+        close: 1.3,
+      },
+    ]);
+    const orderPositionData = createMockOrderPositionData([
+      {
+        bucketWidth: 0.0005,
+        price: 1.0,
+        time: '2025-01-01',
+        buckets: [{ price: 1.0, sentiment: 0.2 }],
+      },
+    ]);
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    expect(result).toBeNull();
+  });
+
+  it('should handle data with multiple candles and books', () => {
+    const priceCandlesData = createMockPriceCandlesData([
+      {
+        point: '2025-01-01T00:00:00Z',
+        high: 1.5,
+        low: 1.0,
+        open: 1.2,
+        close: 1.3,
+      },
+      {
+        point: '2025-01-01T01:00:00Z',
+        high: 1.8,
+        low: 1.1,
+        open: 1.4,
+        close: 1.6,
+      },
+    ]);
+    const orderPositionData = createMockOrderPositionData([
+      {
+        bucketWidth: 0.0005,
+        price: 1.0,
+        time: '2025-01-01',
+        buckets: [{ price: 1.0, sentiment: 0.2 }],
+      },
+      {
+        bucketWidth: 0.0005,
+        price: 1.1,
+        time: '2025-01-02',
+        buckets: [{ price: 1.1, sentiment: 0.3 }],
+      },
+    ]);
+    const result = validateData(priceCandlesData, orderPositionData, true);
+    expect(result).toBeNull();
+  });
+});

package/dist/main/CrowdViewWidget/types/index.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _instruments = require("./instruments");
-Object.keys(_instruments).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _instruments[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _instruments[key];
-    }
-  });
-});
-//# sourceMappingURL=index.js.map

package/dist/main/CrowdViewWidget/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["_instruments","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["../../../../src/CrowdViewWidget/types/index.ts"],"sourcesContent":["export * from './instruments';\n"],"mappings":";;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,YAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,YAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,YAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/main/CrowdViewWidget/types/instruments.js

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.InstrumentIdOC = exports.InstrumentId = void 0;
-let InstrumentId = exports.InstrumentId = function (InstrumentId) {
-  InstrumentId["EUR_AUD"] = "EURAUD";
-  InstrumentId["EUR_GBP"] = "EURGBP";
-  InstrumentId["EUR_JPY"] = "EURJPY";
-  InstrumentId["EUR_USD"] = "EURUSD";
-  InstrumentId["EUR_CHF"] = "EURCHF";
-  InstrumentId["USD_CHF"] = "USDCHF";
-  InstrumentId["USD_JPY"] = "USDJPY";
-  InstrumentId["USD_CAD"] = "USDCAD";
-  InstrumentId["GBP_USD"] = "GBPUSD";
-  InstrumentId["GBP_JPY"] = "GBPJPY";
-  InstrumentId["GBP_CHF"] = "GBPCHF";
-  InstrumentId["AUD_JPY"] = "AUDJPY";
-  InstrumentId["AUD_USD"] = "AUDUSD";
-  InstrumentId["NZD_USD"] = "NZDUSD";
-  InstrumentId["XAU_USD"] = "XAUUSD";
-  InstrumentId["XAG_USD"] = "XAGUSD";
-  return InstrumentId;
-}({});
-let InstrumentIdOC = exports.InstrumentIdOC = function (InstrumentIdOC) {
-  InstrumentIdOC["EUR_AUD"] = "EUR_AUD";
-  InstrumentIdOC["EUR_GBP"] = "EUR_GBP";
-  InstrumentIdOC["EUR_JPY"] = "EUR_JPY";
-  InstrumentIdOC["EUR_USD"] = "EUR_USD";
-  InstrumentIdOC["EUR_CHF"] = "EUR_CHF";
-  InstrumentIdOC["USD_CHF"] = "USD_CHF";
-  InstrumentIdOC["USD_JPY"] = "USD_JPY";
-  InstrumentIdOC["USD_CAD"] = "USD_CAD";
-  InstrumentIdOC["GBP_USD"] = "GBP_USD";
-  InstrumentIdOC["GBP_JPY"] = "GBP_JPY";
-  InstrumentIdOC["GBP_CHF"] = "GBP_CHF";
-  InstrumentIdOC["AUD_JPY"] = "AUD_JPY";
-  InstrumentIdOC["AUD_USD"] = "AUD_USD";
-  InstrumentIdOC["NZD_USD"] = "NZD_USD";
-  InstrumentIdOC["XAU_USD"] = "XAU_USD";
-  InstrumentIdOC["XAG_USD"] = "XAG_USD";
-  return InstrumentIdOC;
-}({});
-//# sourceMappingURL=instruments.js.map

package/dist/main/CrowdViewWidget/types/instruments.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"instruments.js","names":["InstrumentId","exports","InstrumentIdOC"],"sources":["../../../../src/CrowdViewWidget/types/instruments.ts"],"sourcesContent":["export enum InstrumentId {\n  EUR_AUD = 'EURAUD',\n  EUR_GBP = 'EURGBP',\n  EUR_JPY = 'EURJPY',\n  EUR_USD = 'EURUSD',\n  EUR_CHF = 'EURCHF',\n  USD_CHF = 'USDCHF',\n  USD_JPY = 'USDJPY',\n  USD_CAD = 'USDCAD',\n  GBP_USD = 'GBPUSD',\n  GBP_JPY = 'GBPJPY',\n  GBP_CHF = 'GBPCHF',\n  AUD_JPY = 'AUDJPY',\n  AUD_USD = 'AUDUSD',\n  NZD_USD = 'NZDUSD',\n  XAU_USD = 'XAUUSD',\n  XAG_USD = 'XAGUSD',\n}\n\nexport enum InstrumentIdOC {\n  EUR_AUD = 'EUR_AUD',\n  EUR_GBP = 'EUR_GBP',\n  EUR_JPY = 'EUR_JPY',\n  EUR_USD = 'EUR_USD',\n  EUR_CHF = 'EUR_CHF',\n  USD_CHF = 'USD_CHF',\n  USD_JPY = 'USD_JPY',\n  USD_CAD = 'USD_CAD',\n  GBP_USD = 'GBP_USD',\n  GBP_JPY = 'GBP_JPY',\n  GBP_CHF = 'GBP_CHF',\n  AUD_JPY = 'AUD_JPY',\n  AUD_USD = 'AUD_USD',\n  NZD_USD = 'NZD_USD',\n  XAU_USD = 'XAU_USD',\n  XAG_USD = 'XAG_USD',\n}\n"],"mappings":";;;;;;IAAYA,YAAY,GAAAC,OAAA,CAAAD,YAAA,aAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAAA,IAmBZE,cAAc,GAAAD,OAAA,CAAAC,cAAA,aAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}

package/dist/module/CrowdViewWidget/types/index.js

@@ -1,2 +0,0 @@
-export * from './instruments';
-//# sourceMappingURL=index.js.map

package/dist/module/CrowdViewWidget/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../../src/CrowdViewWidget/types/index.ts"],"sourcesContent":["export * from './instruments';\n"],"mappings":"AAAA,cAAc,eAAe","ignoreList":[]}

package/dist/module/CrowdViewWidget/types/instruments.js

@@ -1,39 +0,0 @@
-export let InstrumentId = function (InstrumentId) {
-  InstrumentId["EUR_AUD"] = "EURAUD";
-  InstrumentId["EUR_GBP"] = "EURGBP";
-  InstrumentId["EUR_JPY"] = "EURJPY";
-  InstrumentId["EUR_USD"] = "EURUSD";
-  InstrumentId["EUR_CHF"] = "EURCHF";
-  InstrumentId["USD_CHF"] = "USDCHF";
-  InstrumentId["USD_JPY"] = "USDJPY";
-  InstrumentId["USD_CAD"] = "USDCAD";
-  InstrumentId["GBP_USD"] = "GBPUSD";
-  InstrumentId["GBP_JPY"] = "GBPJPY";
-  InstrumentId["GBP_CHF"] = "GBPCHF";
-  InstrumentId["AUD_JPY"] = "AUDJPY";
-  InstrumentId["AUD_USD"] = "AUDUSD";
-  InstrumentId["NZD_USD"] = "NZDUSD";
-  InstrumentId["XAU_USD"] = "XAUUSD";
-  InstrumentId["XAG_USD"] = "XAGUSD";
-  return InstrumentId;
-}({});
-export let InstrumentIdOC = function (InstrumentIdOC) {
-  InstrumentIdOC["EUR_AUD"] = "EUR_AUD";
-  InstrumentIdOC["EUR_GBP"] = "EUR_GBP";
-  InstrumentIdOC["EUR_JPY"] = "EUR_JPY";
-  InstrumentIdOC["EUR_USD"] = "EUR_USD";
-  InstrumentIdOC["EUR_CHF"] = "EUR_CHF";
-  InstrumentIdOC["USD_CHF"] = "USD_CHF";
-  InstrumentIdOC["USD_JPY"] = "USD_JPY";
-  InstrumentIdOC["USD_CAD"] = "USD_CAD";
-  InstrumentIdOC["GBP_USD"] = "GBP_USD";
-  InstrumentIdOC["GBP_JPY"] = "GBP_JPY";
-  InstrumentIdOC["GBP_CHF"] = "GBP_CHF";
-  InstrumentIdOC["AUD_JPY"] = "AUD_JPY";
-  InstrumentIdOC["AUD_USD"] = "AUD_USD";
-  InstrumentIdOC["NZD_USD"] = "NZD_USD";
-  InstrumentIdOC["XAU_USD"] = "XAU_USD";
-  InstrumentIdOC["XAG_USD"] = "XAG_USD";
-  return InstrumentIdOC;
-}({});
-//# sourceMappingURL=instruments.js.map

package/dist/module/CrowdViewWidget/types/instruments.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"instruments.js","names":["InstrumentId","InstrumentIdOC"],"sources":["../../../../src/CrowdViewWidget/types/instruments.ts"],"sourcesContent":["export enum InstrumentId {\n  EUR_AUD = 'EURAUD',\n  EUR_GBP = 'EURGBP',\n  EUR_JPY = 'EURJPY',\n  EUR_USD = 'EURUSD',\n  EUR_CHF = 'EURCHF',\n  USD_CHF = 'USDCHF',\n  USD_JPY = 'USDJPY',\n  USD_CAD = 'USDCAD',\n  GBP_USD = 'GBPUSD',\n  GBP_JPY = 'GBPJPY',\n  GBP_CHF = 'GBPCHF',\n  AUD_JPY = 'AUDJPY',\n  AUD_USD = 'AUDUSD',\n  NZD_USD = 'NZDUSD',\n  XAU_USD = 'XAUUSD',\n  XAG_USD = 'XAGUSD',\n}\n\nexport enum InstrumentIdOC {\n  EUR_AUD = 'EUR_AUD',\n  EUR_GBP = 'EUR_GBP',\n  EUR_JPY = 'EUR_JPY',\n  EUR_USD = 'EUR_USD',\n  EUR_CHF = 'EUR_CHF',\n  USD_CHF = 'USD_CHF',\n  USD_JPY = 'USD_JPY',\n  USD_CAD = 'USD_CAD',\n  GBP_USD = 'GBP_USD',\n  GBP_JPY = 'GBP_JPY',\n  GBP_CHF = 'GBP_CHF',\n  AUD_JPY = 'AUD_JPY',\n  AUD_USD = 'AUD_USD',\n  NZD_USD = 'NZD_USD',\n  XAU_USD = 'XAU_USD',\n  XAG_USD = 'XAG_USD',\n}\n"],"mappings":"AAAA,WAAYA,YAAY,aAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAmBxB,WAAYC,cAAc,aAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}

package/dist/types/CrowdViewWidget/types/index.d.ts

@@ -1 +0,0 @@
-export * from './instruments';

package/dist/types/CrowdViewWidget/types/instruments.d.ts

@@ -1,36 +0,0 @@
-export declare enum InstrumentId {
-    EUR_AUD = "EURAUD",
-    EUR_GBP = "EURGBP",
-    EUR_JPY = "EURJPY",
-    EUR_USD = "EURUSD",
-    EUR_CHF = "EURCHF",
-    USD_CHF = "USDCHF",
-    USD_JPY = "USDJPY",
-    USD_CAD = "USDCAD",
-    GBP_USD = "GBPUSD",
-    GBP_JPY = "GBPJPY",
-    GBP_CHF = "GBPCHF",
-    AUD_JPY = "AUDJPY",
-    AUD_USD = "AUDUSD",
-    NZD_USD = "NZDUSD",
-    XAU_USD = "XAUUSD",
-    XAG_USD = "XAGUSD"
-}
-export declare enum InstrumentIdOC {
-    EUR_AUD = "EUR_AUD",
-    EUR_GBP = "EUR_GBP",
-    EUR_JPY = "EUR_JPY",
-    EUR_USD = "EUR_USD",
-    EUR_CHF = "EUR_CHF",
-    USD_CHF = "USD_CHF",
-    USD_JPY = "USD_JPY",
-    USD_CAD = "USD_CAD",
-    GBP_USD = "GBP_USD",
-    GBP_JPY = "GBP_JPY",
-    GBP_CHF = "GBP_CHF",
-    AUD_JPY = "AUD_JPY",
-    AUD_USD = "AUD_USD",
-    NZD_USD = "NZD_USD",
-    XAU_USD = "XAU_USD",
-    XAG_USD = "XAG_USD"
-}

package/src/CrowdViewWidget/types/index.ts

@@ -1 +0,0 @@
-export * from './instruments';

package/src/CrowdViewWidget/types/instruments.ts

@@ -1,37 +0,0 @@
-export enum InstrumentId {
-  EUR_AUD = 'EURAUD',
-  EUR_GBP = 'EURGBP',
-  EUR_JPY = 'EURJPY',
-  EUR_USD = 'EURUSD',
-  EUR_CHF = 'EURCHF',
-  USD_CHF = 'USDCHF',
-  USD_JPY = 'USDJPY',
-  USD_CAD = 'USDCAD',
-  GBP_USD = 'GBPUSD',
-  GBP_JPY = 'GBPJPY',
-  GBP_CHF = 'GBPCHF',
-  AUD_JPY = 'AUDJPY',
-  AUD_USD = 'AUDUSD',
-  NZD_USD = 'NZDUSD',
-  XAU_USD = 'XAUUSD',
-  XAG_USD = 'XAGUSD',
-}
-
-export enum InstrumentIdOC {
-  EUR_AUD = 'EUR_AUD',
-  EUR_GBP = 'EUR_GBP',
-  EUR_JPY = 'EUR_JPY',
-  EUR_USD = 'EUR_USD',
-  EUR_CHF = 'EUR_CHF',
-  USD_CHF = 'USD_CHF',
-  USD_JPY = 'USD_JPY',
-  USD_CAD = 'USD_CAD',
-  GBP_USD = 'GBP_USD',
-  GBP_JPY = 'GBP_JPY',
-  GBP_CHF = 'GBP_CHF',
-  AUD_JPY = 'AUD_JPY',
-  AUD_USD = 'AUD_USD',
-  NZD_USD = 'NZD_USD',
-  XAU_USD = 'XAU_USD',
-  XAG_USD = 'XAG_USD',
-}