@bigbinary/neeto-commons-frontend 2.0.103 → 2.0.105

package/react-utils.d.ts

@@ -653,42 +653,34 @@ export function useHotKeys(hotkey: string | string[], handler: (event: React.Key
 export function useStateWithDependency<T>(defaultValue: T, dependencies?: any[]): T;
 /**
  *
- * This hook returns a function that can be used to register navigation checkpoint
+ * This hook will store the path as the value for the key in a Zustand store. This
  *
- * to a Zustand store.
- *
- * The function returned by this hook accepts key and path as arguments. It
- *
- * will store the path as the value for the key in a Zustand store. This
- *
- * registered checkpoint can be retrieved using the useNavigationCheckpoint hook.
+ * registered checkpoint can be retrieved using the useNavigationCheckpoints hook.
  *
  * @example 
  *
- * const registerNavigationCheckpoint = useRegisterNavigationCheckpoint();
- * 
- * useEffect(() => {
- *   registerNavigationCheckpoint(CHECKPOINT_KEY, CHECKPOINT_PATH);
- * }, []);
+ * useRegisterNavigationCheckpoint(CHECKPOINT_KEY, CHECKPOINT_PATH);
  * @endexample
 */
-export function useRegisterNavigationCheckpoint(): (key: string, path: string) => void;
+export function useRegisterNavigationCheckpoint(key: string, path: string): void;
 /**
  *
- * This hook returns the registered navigation checkpoint.
+ * This function returns the specified navigation checkpoints.
  *
  * @example 
  *
- * const navigationCheckpoint = useRegisterNavigationCheckpoint(CHECK_POINT_KEY);
+ * const navigationCheckpoints = useNavigationCheckpoints(checkpointKey1, checkpointKey2);
  * 
  * return (
  *   <>
- *     <Link to={navigationCheckpoint}>Navigate</Link>
+ *     <Link to={navigationCheckpoints[checkpointKey1]}>Navigate</Link>
  *   </>
  * );
  * @endexample
 */
-export function useNavigationCheckpoint(key: string): string;
+export function useNavigationCheckpoints(...keys: string[]): {
+  [key: string]: string;
+};
 /**
  *
  * An HOC which provides the t function from react-i18next to the wrapped

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, includes, __, prop, toPairs, mergeLeft, curry, keys, isEmpty, mergeDeepLeft, path, omit } from 'ramda';
+import { isNil, includes, __, prop, toPairs, mergeLeft, curry, keys, isEmpty, mergeDeepLeft, pick, omit } from 'ramda';
 import { useTranslation, Trans, withTranslation } from 'react-i18next';
 import ErrorPage from '@bigbinary/neeto-molecules/ErrorPage';
 import { Route, Redirect } from 'react-router-dom';
@@ -4161,11 +4161,19 @@ var useCheckpointStore = create$1(withImmutableActions(function (set) {
     }
   };
 }));
-var useRegisterNavigationCheckpoint = function useRegisterNavigationCheckpoint() {
-  return useCheckpointStore(prop("setCheckpoint"));
+var useRegisterNavigationCheckpoint = function useRegisterNavigationCheckpoint(key, path) {
+  var setCheckpoint = useCheckpointStore(prop("setCheckpoint"));
+  useEffect(function () {
+    setCheckpoint(key, path);
+  }, [key, path]);
 };
-var useNavigationCheckpoint = function useNavigationCheckpoint(key) {
-  return useCheckpointStore(path(["checkpoints", key]));
+var useNavigationCheckpoints = function useNavigationCheckpoints() {
+  for (var _len = arguments.length, keys = new Array(_len), _key = 0; _key < _len; _key++) {
+    keys[_key] = arguments[_key];
+  }
+  return useCheckpointStore(function (store) {
+    return pick(keys, store.checkpoints);
+  }, shallow);
 };
 
 var useStateWithDependency = function useStateWithDependency(defaultValue) {
@@ -4709,5 +4717,5 @@ var useUpdateEffect = function useUpdateEffect(callback) {
   }, dependencies);
 };
 
-export { HoneybadgerErrorBoundary, PrivateRoute, destroyBrowserSubscription, handleMetaClick, isMetaKeyPressed, registerBrowserNotifications, useDebounce, useDisplayErrorPage, useErrorDisplayStore, useFuncDebounce, useHotKeys, useIsElementVisibleInDom, useKeyboardShortcutsPaneState, useLocalStorage, useNavigationCheckpoint, useOnClickOutside, usePrevious, useRegisterNavigationCheckpoint, useStateWithDependency, useTimer, useUpdateEffect, withImmutableActions, withT, withTitle };
+export { HoneybadgerErrorBoundary, PrivateRoute, destroyBrowserSubscription, handleMetaClick, isMetaKeyPressed, registerBrowserNotifications, useDebounce, useDisplayErrorPage, useErrorDisplayStore, useFuncDebounce, useHotKeys, useIsElementVisibleInDom, useKeyboardShortcutsPaneState, useLocalStorage, useNavigationCheckpoints, useOnClickOutside, usePrevious, useRegisterNavigationCheckpoint, useStateWithDependency, useTimer, useUpdateEffect, withImmutableActions, withT, withTitle };
 //# sourceMappingURL=react-utils.js.map