Added getAvailableVehicleTypes util function

packages/common/README/UTILITIES.md

@@ -111,6 +111,16 @@ type of variation to use for the interactive colors (lighten or darken the color
 
 ---
 
+# Config Utils
+### getAvailableVehicleTypes
+```typescript
+import { getAvailableVehicleTypes } from '@monkvision/common';
+
+console.log(getAvailableVehicleTypes(config));
+// Output : [VehicleType.CITY, VehicleType.SUV]
+```
+Returns the list of available vehicle types based on the `sights` property of a `CaptureAppConfig` object.
+
 # Environment Utils
 ### getEnvOrThrow
 ```typescript

packages/common/src/apps/appStateProvider.tsx

@@ -13,6 +13,7 @@ import { MonkSearchParam, useMonkSearchParams } from './searchParams';
 import { MonkAppState, MonkAppStateContext } from './appState';
 import { useAppStateMonitoring } from './monitoring';
 import { useAppStateAnalytics } from './analytics';
+import { getAvailableVehicleTypes } from '../utils';
 
 /**
  * Local storage key used within Monk web applications to store the authentication token.
@@ -64,14 +65,6 @@ function getSights(
   });
 }
 
-function getAvailableVehicleTypes(config: CaptureAppConfig): VehicleType[] {
-  return (
-    config.enableSteeringWheelPosition
-      ? Object.keys(config.sights.left)
-      : Object.keys(config.sights)
-  ) as VehicleType[];
-}
-
 /**
  * A React context provider that declares the state for the common parameters used by Monk applications. The parameters
  * are described in the `MonkAppState` interface. Using options available in the App config (`config` prop),  this

packages/common/src/utils/config.utils.ts

@@ -0,0 +1,13 @@
+import { CaptureAppConfig, VehicleType } from '@monkvision/types';
+import { uniq } from './array.utils';
+
+/**
+ * Util function used to extract the list of available vehicle types in a CaptureAppConfig object.
+ */
+export function getAvailableVehicleTypes(config: CaptureAppConfig): VehicleType[] {
+  return (
+    config.enableSteeringWheelPosition
+      ? uniq([...Object.keys(config.sights.left), ...Object.keys(config.sights.right)])
+      : Object.keys(config.sights)
+  ) as VehicleType[];
+}

packages/common/src/utils/index.ts

@@ -7,3 +7,4 @@ export * from './zlib.utils';
 export * from './browser.utils';
 export * from './env.utils';
 export * from './state.utils';
+export * from './config.utils';

packages/common/test/apps/appStateProvider.test.tsx

@@ -5,6 +5,9 @@ jest.mock('../../src/apps/searchParams', () => ({
   ...jest.requireActual('../../src/apps/searchParams'),
   useMonkSearchParams: jest.fn(() => ({ get: searchParamsGet })),
 }));
+jest.mock('../../src/utils', () => ({
+  getAvailableVehicleTypes: jest.fn(({ sights }) => Object.keys(sights)),
+}));
 
 import React, { useContext, useEffect } from 'react';
 import { CaptureAppConfig, SteeringWheelPosition, VehicleType } from '@monkvision/types';

packages/common/test/utils/config.utils.test.ts

@@ -0,0 +1,40 @@
+import { CaptureAppConfig, SteeringWheelPosition, VehicleType } from '@monkvision/types';
+import { getAvailableVehicleTypes } from '../../src';
+
+describe('Config utils', () => {
+  describe('getAvailableVehicleTypes function', () => {
+    it('should return the list of available vehicle types in non-steering wheel sights', () => {
+      const config = {
+        enableSteeringWheelPosition: false,
+        sights: { [VehicleType.SEDAN]: [], [VehicleType.HGV]: [] },
+      } as unknown as CaptureAppConfig;
+      expect(getAvailableVehicleTypes(config)).toEqual([VehicleType.SEDAN, VehicleType.HGV]);
+    });
+
+    it('should return the list of available vehicle types in steering wheel enabled sights', () => {
+      const config = {
+        enableSteeringWheelPosition: true,
+        sights: {
+          [SteeringWheelPosition.LEFT]: { [VehicleType.VAN]: [], [VehicleType.CITY]: [] },
+          [SteeringWheelPosition.RIGHT]: { [VehicleType.VAN]: [], [VehicleType.CITY]: [] },
+        },
+      } as unknown as CaptureAppConfig;
+      expect(getAvailableVehicleTypes(config)).toEqual([VehicleType.VAN, VehicleType.CITY]);
+    });
+
+    it('should return the list of available vehicle types in steering wheel enabled sights with different sights for each side', () => {
+      const config = {
+        enableSteeringWheelPosition: true,
+        sights: {
+          [SteeringWheelPosition.LEFT]: { [VehicleType.VAN]: [], [VehicleType.LARGE_SUV]: [] },
+          [SteeringWheelPosition.RIGHT]: { [VehicleType.VAN]: [], [VehicleType.HATCHBACK]: [] },
+        },
+      } as unknown as CaptureAppConfig;
+      expect(getAvailableVehicleTypes(config)).toEqual([
+        VehicleType.VAN,
+        VehicleType.LARGE_SUV,
+        VehicleType.HATCHBACK,
+      ]);
+    });
+  });
+});