@bigbinary/neeto-commons-frontend 2.0.69 → 2.0.71

package/react-utils.d.ts

@@ -51,13 +51,21 @@ export const HoneybadgerErrorBoundary: React.FC<{
 }>;
 /**
  *
- * A route that will restrict access to it based on a specified condition.
+ * A route that will restrict access to it based on a specified condition and
  *
- * If the given condition is true, it acts identical to a normal route. Otherwise
+ * permissions.
  *
- * we have two options: it can either redirect user to a different path or it can
+ * If the given condition is true and the user has the required permissions, it
  *
- * render a supplied error page instead of the actual component in that route.
+ * acts identical to a normal route. If the condition is true and the user does not
+ *
+ * have the required permissions, it will show 403 error page or it will render a
+ *
+ * supplied error page. If the condition is false, it will redirect user to a
+ *
+ * different path if redirectRoute is specified or it will render a supplied error
+ *
+ * page.
  *
  * If condition is not specified, it will assume the value of
  *
@@ -70,6 +78,7 @@ export function PrivateRoute(props: {
   condition?: boolean;
   redirectRoute?: string;
   errorPage?: React.ReactNode;
+  permissions?: string[];
 } & RouteProps): JSX.Element;
 type OptionsType = {
   root?: Element | null;
@@ -604,4 +613,20 @@ type ConfigType = {
  * );
  * @endexample
 */
-export function useHotKeys(hotkey: string | string[], handler: (event: React.KeyboardEvent) => void, config?: ConfigType): React.MutableRefObject | null;
+export function useHotKeys(hotkey: string | string[], handler: (event: React.KeyboardEvent) => void, config?: ConfigType): React.MutableRefObject | null;
+/**
+ *
+ * This hook returns a state that automatically updates its value to defaultValue whenever defaultValue changes. We can also specify a dependencies array to listen to other variable changes.
+ *
+ * This hook accepts a defaultValue and an optional array called dependencies. If dependencies is passed, the hook returns a state variable whose value will be updated to defaultValue in a useEffect that depends on the dependencies array. Otherwise, the useEffect will depend only on the defaultValue.
+ *
+ * @example 
+ *
+ * const [value, setValue] = useStateWithDependency(defaultValue);// reset state to `defaultValue` whenever `defaultValue` changes.
+ * const [value, setValue] = useStateWithDependency(defaultValue, [value1, value2]); // reset state to `defaultValue` only when `value1` or `value2` changes.
+ * 
+ * // In a case, where the value needs to be reset when defaultValue changes too, defaultValue can be passed with the dependencies, as shown below.
+ * const [value, setValue] = useStateWithDependency(defaultValue, [ value1, value2, defaultValue ]);
+ * @endexample
+*/
+export function useStateWithDependency<T>(defaultValue: T, dependencies?: any[]): T;

package/react-utils.js

@@ -2,7 +2,7 @@ import * as React from 'react';
 import React__default, { useEffect, useState, useDebugValue, useRef, useMemo } from 'react';
 import { Honeybadger, HoneybadgerErrorBoundary as HoneybadgerErrorBoundary$1 } from '@honeybadger-io/react';
 import { Typography, Button } from '@bigbinary/neetoui';
-import { isNil, prop, toPairs, mergeLeft, isEmpty, omit, curry } from 'ramda';
+import { isNil, includes, __, prop, toPairs, mergeLeft, isEmpty, omit, curry } from 'ramda';
 import { useTranslation, Trans } from 'react-i18next';
 import ErrorPage from '@bigbinary/neeto-molecules/ErrorPage';
 import { Route, Redirect } from 'react-router-dom';
@@ -152,7 +152,7 @@ function _objectWithoutProperties(source, excluded) {
   return target;
 }
 
-var _excluded = ["condition", "redirectRoute", "errorPage"];
+var _excluded = ["condition", "redirectRoute", "errorPage", "permissions"];
 var PrivateRoute = function PrivateRoute(_ref) {
   var _ref$condition = _ref.condition,
     condition = _ref$condition === void 0 ? globalProps.authenticated : _ref$condition,
@@ -160,17 +160,27 @@ var PrivateRoute = function PrivateRoute(_ref) {
     redirectRoute = _ref$redirectRoute === void 0 ? undefined : _ref$redirectRoute,
     _ref$errorPage = _ref.errorPage,
     errorPage = _ref$errorPage === void 0 ? undefined : _ref$errorPage,
+    _ref$permissions = _ref.permissions,
+    permissions = _ref$permissions === void 0 ? undefined : _ref$permissions,
     props = _objectWithoutProperties(_ref, _excluded);
-  return (
-    // eslint-disable-next-line no-nested-ternary
-    condition ? /*#__PURE__*/React__default.createElement(Route, props) : redirectRoute ? /*#__PURE__*/React__default.createElement(Redirect, {
+  if (condition) {
+    if (permissions) {
+      return globalProps.permissions.some(includes(__, permissions)) ? /*#__PURE__*/React__default.createElement(Route, props) : errorPage || /*#__PURE__*/React__default.createElement(ErrorPage, {
+        status: 403
+      });
+    }
+    return /*#__PURE__*/React__default.createElement(Route, props);
+  }
+  if (redirectRoute) {
+    return /*#__PURE__*/React__default.createElement(Redirect, {
       to: {
         pathname: redirectRoute
       }
-    }) : errorPage || /*#__PURE__*/React__default.createElement(ErrorPage, {
-      status: "403"
-    })
-  );
+    });
+  }
+  return errorPage || /*#__PURE__*/React__default.createElement(ErrorPage, {
+    status: 403
+  });
 };
 
 function _arrayWithHoles(arr) {
@@ -3442,6 +3452,18 @@ var usePrevious = function usePrevious(value) {
   return ref.current;
 };
 
+var useStateWithDependency = function useStateWithDependency(defaultValue) {
+  var dependencies = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [defaultValue];
+  var _useState = useState(defaultValue),
+    _useState2 = _slicedToArray(_useState, 2),
+    value = _useState2[0],
+    setValue = _useState2[1];
+  useEffect(function () {
+    setValue(defaultValue);
+  }, dependencies);
+  return [value, setValue];
+};
+
 function _typeof$1(obj) {
   "@babel/helpers - typeof";
 
@@ -4668,5 +4690,5 @@ var withImmutableActions = function withImmutableActions(config) {
   };
 };
 
-export { HoneybadgerErrorBoundary, PrivateRoute, destroyBrowserSubscription, handleMetaClick, isMetaKeyPressed, registerBrowserNotifications, useDebounce, useDisplayErrorPage, useErrorDisplayStore, useFuncDebounce, useHotKeys, useIsElementVisibleInDom, useKeyboardShortcutsPaneState, useLocalStorage, useOnClickOutside, usePrevious, useTimer, useUpdateEffect, withImmutableActions, withTitle };
+export { HoneybadgerErrorBoundary, PrivateRoute, destroyBrowserSubscription, handleMetaClick, isMetaKeyPressed, registerBrowserNotifications, useDebounce, useDisplayErrorPage, useErrorDisplayStore, useFuncDebounce, useHotKeys, useIsElementVisibleInDom, useKeyboardShortcutsPaneState, useLocalStorage, useOnClickOutside, usePrevious, useStateWithDependency, useTimer, useUpdateEffect, withImmutableActions, withTitle };
 //# sourceMappingURL=react-utils.js.map