@monkvision/common 4.0.20 → 4.0.21

package/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

package/lib/apps/appStateProvider.js

@@ -20,6 +20,7 @@ var searchParams_1 = require("./searchParams");
 var appState_1 = require("./appState");
 var monitoring_1 = require("./monitoring");
 var analytics_1 = require("./analytics");
+var utils_1 = require("../utils");
 /**
  * Local storage key used within Monk web applications to store the authentication token.
  */
@@ -44,11 +45,6 @@ function getSights(config, vehicleType, steeringWheel) {
         return sights_1.sights[id];
     });
 }
-function getAvailableVehicleTypes(config) {
-    return (config.enableSteeringWheelPosition
-        ? Object.keys(config.sights.left)
-        : Object.keys(config.sights));
-}
 /**
  * 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
@@ -65,7 +61,7 @@ function MonkAppStateProvider(_a) {
     var _c = (0, react_1.useState)(null), inspectionId = _c[0], setInspectionId = _c[1];
     var _d = (0, react_1.useState)(null), vehicleType = _d[0], setVehicleType = _d[1];
     var _e = (0, react_1.useState)(null), steeringWheel = _e[0], setSteeringWheel = _e[1];
-    var availableVehicleTypes = (0, react_1.useMemo)(function () { return getAvailableVehicleTypes(config); }, [config]);
+    var availableVehicleTypes = (0, react_1.useMemo)(function () { return (0, utils_1.getAvailableVehicleTypes)(config); }, [config]);
     var monkSearchParams = (0, searchParams_1.useMonkSearchParams)({ availableVehicleTypes: availableVehicleTypes });
     (0, monitoring_1.useAppStateMonitoring)({ authToken: authToken, inspectionId: inspectionId, vehicleType: vehicleType, steeringWheel: steeringWheel });
     (0, analytics_1.useAppStateAnalytics)({ inspectionId: inspectionId });

package/lib/utils/config.utils.d.ts

@@ -0,0 +1,5 @@
+import { CaptureAppConfig, VehicleType } from '@monkvision/types';
+/**
+ * Util function used to extract the list of available vehicle types in a CaptureAppConfig object.
+ */
+export declare function getAvailableVehicleTypes(config: CaptureAppConfig): VehicleType[];

package/lib/utils/config.utils.js

@@ -0,0 +1,22 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAvailableVehicleTypes = void 0;
+var array_utils_1 = require("./array.utils");
+/**
+ * Util function used to extract the list of available vehicle types in a CaptureAppConfig object.
+ */
+function getAvailableVehicleTypes(config) {
+    return (config.enableSteeringWheelPosition
+        ? (0, array_utils_1.uniq)(__spreadArray(__spreadArray([], Object.keys(config.sights.left), true), Object.keys(config.sights.right), true))
+        : Object.keys(config.sights));
+}
+exports.getAvailableVehicleTypes = getAvailableVehicleTypes;

package/lib/utils/index.d.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';

package/lib/utils/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./zlib.utils"), exports);
 __exportStar(require("./browser.utils"), exports);
 __exportStar(require("./env.utils"), exports);
 __exportStar(require("./state.utils"), exports);
+__exportStar(require("./config.utils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/common",
-  "version": "4.0.20",
+  "version": "4.0.21",
   "license": "BSD-3-Clause-Clear",
   "packageManager": "yarn@3.2.4",
   "description": "MonkJs common logic package",
@@ -28,10 +28,10 @@
     "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
   },
   "dependencies": {
-    "@monkvision/analytics": "4.0.20",
-    "@monkvision/monitoring": "4.0.20",
-    "@monkvision/sights": "4.0.20",
-    "@monkvision/types": "4.0.20",
+    "@monkvision/analytics": "4.0.21",
+    "@monkvision/monitoring": "4.0.21",
+    "@monkvision/sights": "4.0.21",
+    "@monkvision/types": "4.0.21",
     "i18next": "^23.4.5",
     "jsonwebtoken": "^9.0.2",
     "jwt-decode": "^4.0.0",
@@ -47,13 +47,13 @@
     "react-router-dom": "^6.22.3"
   },
   "devDependencies": {
-    "@monkvision/eslint-config-base": "4.0.20",
-    "@monkvision/eslint-config-typescript": "4.0.20",
-    "@monkvision/eslint-config-typescript-react": "4.0.20",
-    "@monkvision/jest-config": "4.0.20",
-    "@monkvision/prettier-config": "4.0.20",
-    "@monkvision/test-utils": "4.0.20",
-    "@monkvision/typescript-config": "4.0.20",
+    "@monkvision/eslint-config-base": "4.0.21",
+    "@monkvision/eslint-config-typescript": "4.0.21",
+    "@monkvision/eslint-config-typescript-react": "4.0.21",
+    "@monkvision/jest-config": "4.0.21",
+    "@monkvision/prettier-config": "4.0.21",
+    "@monkvision/test-utils": "4.0.21",
+    "@monkvision/typescript-config": "4.0.21",
     "@testing-library/react": "^12.1.5",
     "@testing-library/react-hooks": "^8.0.1",
     "@types/jest": "^29.2.2",
@@ -96,5 +96,5 @@
     "url": "https://github.com/monkvision/monkjs/issues"
   },
   "homepage": "https://github.com/monkvision/monkjs",
-  "gitHead": "04ea8708475a1638687426e5e9a4f68d8189368e"
+  "gitHead": "6b016ec12274d4f388b359eee1a907980368051b"
 }