@tracktor/shared-module 2.6.3 → 2.7.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # [Versions](https://github.com/Tracktor/shared-module/releases)
 
-## v2.6.3
-- **[fix]** - sentry error : null is not an object (evaluating 'window.localStorage.getItem')
+## v2.7.0
+- **[feat]** - add `useFilter` hook
+- **[feat]** - add `localStorageKeys` in props of `InjectDependenciesContext` context

package/dist/components/Utils/InitializeAxiosConfig.d.ts

@@ -33,10 +33,9 @@ interface InitializeAxiosConfigProps {
  * This component initialize Axios instance with custom default config options
  * @param axios
  * @param tokenTypeKey
- * @param userLocalStorageKey
  * @param tokenKey
  * @param postContentType
  * @constructor
  */
-declare const InitializeAxiosConfig: ({ tokenTypeKey, userLocalStorageKey, tokenKey, postContentType, ...props }: InitializeAxiosConfigProps) => null;
+declare const InitializeAxiosConfig: ({ tokenTypeKey, tokenKey, postContentType, ...props }: InitializeAxiosConfigProps) => null;
 export default InitializeAxiosConfig;

package/dist/context/InjectDependenciesProvider.d.ts

@@ -8,6 +8,19 @@ export interface InjectDependenciesContextProps {
      * API URL dependency for useAdapter hook
      */
     apiURL?: string;
+    /**
+     * Local storage keys
+     */
+    localStorageKeys?: {
+        /**
+         * Local storage key for filters, used in useFilters hook
+         */
+        filter?: string;
+        /**
+         * Local storage key for user, used in useUser hook
+         */
+        user?: string;
+    };
     /**
      * List of dependencies for libraries
      */
@@ -39,5 +52,5 @@ export declare const InjectDependenciesContext: import("react").Context<InjectDe
  * @param apiURL
  * @constructor
  */
-declare const InjectDependenciesProvider: ({ children, apiURL, libraries }: InjectDependenciesContextProps) => import("react/jsx-runtime").JSX.Element;
+declare const InjectDependenciesProvider: ({ children, apiURL, libraries, localStorageKeys }: InjectDependenciesContextProps) => import("react/jsx-runtime").JSX.Element;
 export default InjectDependenciesProvider;

package/dist/hooks/{useAdapter/useAdapter.d.ts → useAdapter.d.ts}

@@ -1,4 +1,4 @@
-import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+import { InjectDependenciesContextProps } from '../context/InjectDependenciesProvider';
 export interface useAdapterParams {
     /**
      * Dayjs library

package/dist/hooks/{useAuth/useAuth.d.ts → useAuth.d.ts}

@@ -1,4 +1,4 @@
-import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+import { InjectDependenciesContextProps } from '../context/InjectDependenciesProvider';
 interface useAuthParams {
     /**
      * Axios library

package/dist/hooks/useFilters.d.ts

@@ -0,0 +1,29 @@
+import { SyntheticEvent } from "react";
+import { InjectDependenciesContextProps } from '../context/InjectDependenciesProvider';
+interface useFiltersOptions {
+    /**
+     * Pathname to store filters
+     * Defined to set filters for different pages to store in local storage
+     * @example If you want same filter for "/deals", "/deals/planning" and "/deals/list"
+     * Then you can define pathname "useFilters({ pathname: "/deals" })" and filter will be shared between these pages
+     * @default pathname from useLocation
+     */
+    pathname?: string;
+    /**
+     * React Router library
+     */
+    reactRouter?: NonNullable<InjectDependenciesContextProps["libraries"]>["reactRouter"];
+}
+/**
+ * Hook to handle filter
+ * @param options
+ */
+declare const useFilters: (options?: useFiltersOptions) => {
+    getFilter: <T = string, DefaultValue = undefined>(name: string, defaultValue?: T | undefined) => DefaultValue extends undefined ? T | undefined : T;
+    getFilters: () => {
+        [x: string]: any;
+    };
+    handleFilter: <T_1>(name: string, key?: string) => (_: SyntheticEvent, value?: T_1 | undefined) => void;
+    setFilter: (name: string, value: unknown, persist?: boolean) => void;
+};
+export default useFilters;

package/dist/main.d.ts

@@ -20,16 +20,18 @@ export { default as InjectDependenciesProvider } from './context/InjectDependenc
 export * from './context/InjectDependenciesProvider';
 export { default as QueryClientProviderWithConfig } from './context/QueryClientProviderWithConfig';
 export * from './context/QueryClientProviderWithConfig';
-export { default as useResponseError } from './hooks/useResponseError';
-export * from './hooks/useResponseError';
+export { default as useResponseError } from './hooks/useResponseError/useResponseError';
+export * from './hooks/useResponseError/useResponseError';
 export { default as useInfiniteDataGrid } from './hooks/useInfiniteDataGrid';
 export * from './hooks/useInfiniteDataGrid';
 export { default as useAuth } from './hooks/useAuth';
 export * from './hooks/useAuth';
 export { default as useAdapter } from './hooks/useAdapter';
 export * from './hooks/useAdapter';
-export { default as useCurrentLanguage } from './hooks/useCurrentLanguage';
-export * from './hooks/useCurrentLanguage';
+export { default as useCurrentLanguage } from './hooks/useCurrentLanguage/useCurrentLanguage';
+export * from './hooks/useCurrentLanguage/useCurrentLanguage';
+export { default as useFilters } from './hooks/useFilters';
+export * from './hooks/useFilters';
 export { default as getOrvalConfig } from './config/orval';
 export * from './config/orval';
 export { default as dateAdapter } from './utils/adapter/dateAdapter';