@monkvision/common 4.0.11 → 4.0.13

package/README/INTERNATIONALIZATION.md

@@ -24,6 +24,36 @@ specify to it which language you want it to use. The following languages are sup
 - Dutch
 
 # i18n Utilities
+## i18nWrap wrapper
+### Description
+This wrapped is used by internal monk SDK to wrap the component with I18nextProvider.
+
+### Example of usage
+
+```ts
+import i18n from '@monkvision/common';
+import { i18nMyComponent } from './i18n';
+
+const MyComponent = i18nWrap(function MyComponent(){
+  return <></>
+}, i18nMyComponent)
+/// in i18n.ts
+import { i18nCreateSDKInstance } from '@monkvision/common';
+import en from './translations/en.json';
+import fr from './translations/fr.json';
+import de from './translations/de.json';
+import nl from './translations/nl.json';
+
+const i18nMyComponent = i18nCreateSDKInstance({
+  resources: {
+    en: { translation: en },
+    fr: { translation: fr },
+    de: { translation: de },
+    nl: { translation: nl },
+  }
+})
+```
+
 ## useI18nSync hook
 ### Description
 This hook is used mostly by MonkJs packages internally to synchronize their own i18n instance with the language param
@@ -31,7 +61,7 @@ or prop that they are provided.
 
 ### Example of usage
 
-```typescript
+```ts
 import i18n from 'i18next';
 import { useI18nSync } from '@monkvision/common';
 

package/lib/apps/appStateProvider.js

@@ -44,6 +44,11 @@ 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
@@ -60,7 +65,8 @@ 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 monkSearchParams = (0, searchParams_1.useMonkSearchParams)();
+    var availableVehicleTypes = (0, react_1.useMemo)(function () { return 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 });
     (0, react_1.useEffect)(function () {

package/lib/apps/searchParams.d.ts

@@ -50,11 +50,22 @@ export type MonkSearchParamsGetter = {
     (param: MonkSearchParam.STEERING_WHEEL): SteeringWheelPosition | null;
     (param: MonkSearchParam.LANGUAGE): MonkLanguage | null;
 };
+/**
+ * Options accepted by the useMonkSearchParams hook.
+ */
+export interface UseMonkSearchParamsOptions {
+    /**
+     * The list of available vehicle types to allow.
+     *
+     * @default Object.values(VehicleType)
+     */
+    availableVehicleTypes?: VehicleType[];
+}
 /**
  * Custom hook used to return a getter function used to fetch the value of different MonkSearchParams.
  *
  * @see MonkSearchParam
  */
-export declare function useMonkSearchParams(): {
+export declare function useMonkSearchParams({ availableVehicleTypes }?: UseMonkSearchParamsOptions): {
     get: MonkSearchParamsGetter;
 };

package/lib/apps/searchParams.js

@@ -56,7 +56,8 @@ function validateParamValue(value, validValues) {
  *
  * @see MonkSearchParam
  */
-function useMonkSearchParams() {
+function useMonkSearchParams(_a) {
+    var _b = _a === void 0 ? {} : _a, availableVehicleTypes = _b.availableVehicleTypes;
     var searchParams = (0, hooks_1.useSearchParams)();
     var get = (0, react_1.useCallback)(function (param) {
         var value = searchParams.get(param);
@@ -66,7 +67,7 @@ function useMonkSearchParams() {
             case MonkSearchParam.INSPECTION_ID:
                 return value;
             case MonkSearchParam.VEHICLE_TYPE:
-                return validateParamValue(value, types_1.VehicleType);
+                return validateParamValue(value, availableVehicleTypes !== null && availableVehicleTypes !== void 0 ? availableVehicleTypes : types_1.VehicleType);
             case MonkSearchParam.STEERING_WHEEL:
                 return validateParamValue(value, types_1.SteeringWheelPosition);
             case MonkSearchParam.LANGUAGE:

package/lib/i18n/utils.d.ts

@@ -25,10 +25,10 @@ export interface I18NSDKOptions {
  */
 export declare function i18nCreateSDKInstance({ resources }: I18NSDKOptions): i18n;
 /**
- * This function is used internally by the Monk SDK to wrap its exported components in an I18nextProvder. The ref passed
- * to the resulting component is forwarded to the wrapped component.
+ * This function is used internally by the Monk SDK to wrap its exported components in an I18nextProvider. The ref
+ * passed to the resulting component is forwarded to the wrapped component.
  *
- * @param Component The component to wrap in the provider.
+ * @param Component The component to wrap in the provider. It should be an functional component
  * @param instance The i18n instance created using the `i18nCreateSDKInstance` function.
  * @typeParam T - The type of the ref of the wrapped component.
  * @typeParam P - The type of the props of the wrapped component.

package/lib/i18n/utils.js

@@ -58,17 +58,19 @@ function i18nCreateSDKInstance(_a) {
 }
 exports.i18nCreateSDKInstance = i18nCreateSDKInstance;
 /**
- * This function is used internally by the Monk SDK to wrap its exported components in an I18nextProvder. The ref passed
- * to the resulting component is forwarded to the wrapped component.
+ * This function is used internally by the Monk SDK to wrap its exported components in an I18nextProvider. The ref
+ * passed to the resulting component is forwarded to the wrapped component.
  *
- * @param Component The component to wrap in the provider.
+ * @param Component The component to wrap in the provider. It should be an functional component
  * @param instance The i18n instance created using the `i18nCreateSDKInstance` function.
  * @typeParam T - The type of the ref of the wrapped component.
  * @typeParam P - The type of the props of the wrapped component.
  * @return The Component passed in the arguments. wrapped in an I18nextProvider.
  */
 function i18nWrap(Component, instance) {
-    return (0, react_1.forwardRef)(function (props, ref) { return ((0, jsx_runtime_1.jsx)(react_i18next_1.I18nextProvider, __assign({ i18n: instance }, { children: (0, jsx_runtime_1.jsx)(Component, __assign({ ref: ref }, props)) }))); });
+    return (0, react_1.forwardRef)(function I18nWrappedComponent(props, ref) {
+        return ((0, jsx_runtime_1.jsx)(react_i18next_1.I18nextProvider, __assign({ i18n: instance }, { children: (0, jsx_runtime_1.jsx)(Component, __assign({ ref: ref }, props)) })));
+    });
 }
 exports.i18nWrap = i18nWrap;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/common",
-  "version": "4.0.11",
+  "version": "4.0.13",
   "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.11",
-    "@monkvision/monitoring": "4.0.11",
-    "@monkvision/sights": "4.0.11",
-    "@monkvision/types": "4.0.11",
+    "@monkvision/analytics": "4.0.13",
+    "@monkvision/monitoring": "4.0.13",
+    "@monkvision/sights": "4.0.13",
+    "@monkvision/types": "4.0.13",
     "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.11",
-    "@monkvision/eslint-config-typescript": "4.0.11",
-    "@monkvision/eslint-config-typescript-react": "4.0.11",
-    "@monkvision/jest-config": "4.0.11",
-    "@monkvision/prettier-config": "4.0.11",
-    "@monkvision/test-utils": "4.0.11",
-    "@monkvision/typescript-config": "4.0.11",
+    "@monkvision/eslint-config-base": "4.0.13",
+    "@monkvision/eslint-config-typescript": "4.0.13",
+    "@monkvision/eslint-config-typescript-react": "4.0.13",
+    "@monkvision/jest-config": "4.0.13",
+    "@monkvision/prettier-config": "4.0.13",
+    "@monkvision/test-utils": "4.0.13",
+    "@monkvision/typescript-config": "4.0.13",
     "@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": "87174eb3fee2aae001e6e8ed738057c67898b252"
+  "gitHead": "aaed1ea6df50b958aa5b3bba3765235847ad895e"
 }