@monkvision/common 4.3.11 → 4.3.13

package/README/HOOKS.md

@@ -83,6 +83,26 @@ function TestComponent() {
 This custom hook creates an interval that calls the provided callback every `delay` milliseconds. If `delay` is `null`
 or less than 0, the callback will not be called.
 
+### useIsMounted
+```tsx
+import { useIsMounted } from '@monkvision/common';
+
+function TestComponent() {
+  const [example, setExample] = useState(0);
+  const isMounted = useIsMounted();
+
+  useEffect(() => {
+    myAsyncFunc().then((value) => {
+      if (isMounted()) {
+        setExample(value);
+      }
+    }).catch(console.error);
+  }, [isMounted]);
+}
+```
+Custom hook returning a ref to a util function returning `true` if the component using the hook is mounted, and false
+otherwise. Can be used to cancel asynchronous calls on component unmounts.
+
 ### useForm
 
 ```tsx

package/lib/apps/appStateProvider.js

@@ -21,6 +21,7 @@ var appState_1 = require("./appState");
 var monitoring_1 = require("./monitoring");
 var analytics_1 = require("./analytics");
 var utils_1 = require("../utils");
+var useIsMounted_1 = require("../hooks/useIsMounted");
 /**
  * Local storage key used within Monk web applications to store the authentication token.
  */
@@ -63,6 +64,7 @@ function MonkAppStateProvider(_a) {
     var _e = (0, react_1.useState)(null), steeringWheel = _e[0], setSteeringWheel = _e[1];
     var availableVehicleTypes = (0, react_1.useMemo)(function () { return (0, utils_1.getAvailableVehicleTypes)(config); }, [config]);
     var monkSearchParams = (0, searchParams_1.useMonkSearchParams)({ availableVehicleTypes: availableVehicleTypes });
+    var isMounted = (0, useIsMounted_1.useIsMounted)();
     (0, monitoring_1.useAppStateMonitoring)({ authToken: authToken, inspectionId: inspectionId, vehicleType: vehicleType, steeringWheel: steeringWheel });
     (0, analytics_1.useAppStateAnalytics)({ inspectionId: inspectionId });
     (0, react_1.useEffect)(function () {
@@ -75,11 +77,11 @@ function MonkAppStateProvider(_a) {
             setVehicleType(function (param) { var _a; return (_a = monkSearchParams.get(searchParams_1.MonkSearchParam.VEHICLE_TYPE)) !== null && _a !== void 0 ? _a : param; });
             setSteeringWheel(function (param) { var _a; return (_a = monkSearchParams.get(searchParams_1.MonkSearchParam.STEERING_WHEEL)) !== null && _a !== void 0 ? _a : param; });
             var lang = monkSearchParams.get(searchParams_1.MonkSearchParam.LANGUAGE);
-            if (lang) {
+            if (lang && isMounted()) {
                 onFetchLanguage === null || onFetchLanguage === void 0 ? void 0 : onFetchLanguage(lang);
             }
         }
-        if (fetchedToken) {
+        if (fetchedToken && isMounted()) {
             setAuthToken(fetchedToken);
             onFetchAuthToken === null || onFetchAuthToken === void 0 ? void 0 : onFetchAuthToken();
         }

package/lib/hooks/useIsMounted.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Custom hook returning a ref to a util function returning `true` if the component using the hook is mounted, and false
+ * otherwise.
+ */
+export declare function useIsMounted(): () => boolean;

package/lib/hooks/useIsMounted.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useIsMounted = void 0;
+var react_1 = require("react");
+/**
+ * Custom hook returning a ref to a util function returning `true` if the component using the hook is mounted, and false
+ * otherwise.
+ */
+function useIsMounted() {
+    var isMounted = (0, react_1.useRef)(false);
+    (0, react_1.useEffect)(function () {
+        isMounted.current = true;
+        return function () {
+            isMounted.current = false;
+        };
+    }, []);
+    return (0, react_1.useCallback)(function () { return isMounted.current; }, []);
+}
+exports.useIsMounted = useIsMounted;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/common",
-  "version": "4.3.11",
+  "version": "4.3.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.3.11",
-    "@monkvision/monitoring": "4.3.11",
-    "@monkvision/sights": "4.3.11",
-    "@monkvision/types": "4.3.11",
+    "@monkvision/analytics": "4.3.13",
+    "@monkvision/monitoring": "4.3.13",
+    "@monkvision/sights": "4.3.13",
+    "@monkvision/types": "4.3.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.3.11",
-    "@monkvision/eslint-config-typescript": "4.3.11",
-    "@monkvision/eslint-config-typescript-react": "4.3.11",
-    "@monkvision/jest-config": "4.3.11",
-    "@monkvision/prettier-config": "4.3.11",
-    "@monkvision/test-utils": "4.3.11",
-    "@monkvision/typescript-config": "4.3.11",
+    "@monkvision/eslint-config-base": "4.3.13",
+    "@monkvision/eslint-config-typescript": "4.3.13",
+    "@monkvision/eslint-config-typescript-react": "4.3.13",
+    "@monkvision/jest-config": "4.3.13",
+    "@monkvision/prettier-config": "4.3.13",
+    "@monkvision/test-utils": "4.3.13",
+    "@monkvision/typescript-config": "4.3.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": "4d831f9a606fba471837296214ef748c03e7a2e9"
+  "gitHead": "01b426413fda27038e5ecbcb74037f2d077a97c6"
 }