fastapi-rtk 0.1.35 → 0.1.36

package/dist/core/cjs/Tables/NextGenDataGrid/hooks/useColumns/ColumnHeaderFilter.cjs

@@ -21,6 +21,8 @@ const ColumnHeaderFilter = ({
   filterMenu,
   filterModeDescription,
   updateQueryParams,
+  withLocalStorage,
+  localStorageKey,
   mrtProps
 }) => {
   var _a;
@@ -49,6 +51,8 @@ const ColumnHeaderFilter = ({
           filterState,
           filterSync,
           updateQueryParams,
+          withLocalStorage,
+          localStorageKey,
           filters,
           actionIconProps,
           filterProps,

package/dist/core/cjs/Tables/NextGenDataGrid/hooks/useColumns/ColumnHeaderFilterInput/ColumnHeaderFilterInput.cjs

@@ -13,6 +13,29 @@ const useApi = require("../../../../../hooks/api/useApi.cjs");
 const utils$2 = require("../../../utils.cjs");
 const utils$1 = require("../utils.cjs");
 const HeaderInput = require("./HeaderInput.cjs");
+const getLocalStorageValue = (key, defaultValue) => {
+  const value = localStorage.getItem(key);
+  if (value === null) {
+    return defaultValue;
+  }
+  try {
+    return JSON.parse(value);
+  } catch (e) {
+    console.error(`Error parsing localStorage value for key "${key}":`, e);
+    return defaultValue;
+  }
+};
+const setLocalStorageValue = (key, value) => {
+  if (value === void 0) {
+    localStorage.removeItem(key);
+  } else {
+    try {
+      localStorage.setItem(key, JSON.stringify(value));
+    } catch (e) {
+      console.error(`Error setting localStorage value for key "${key}":`, e);
+    }
+  }
+};
 const FilterIconWrapper = React.forwardRef(({ label, disabled, children, ...props }, ref) => {
   if (disabled) {
     return React.cloneElement(children, { ref });
@@ -40,13 +63,15 @@ function ColumnHeaderFilterInput({
   filterState,
   filterSync,
   updateQueryParams,
+  withLocalStorage,
+  localStorageKey,
   actionIconProps,
   functionProps,
   mrtProps
 }) {
   var _a, _b;
   const { column } = mrtProps;
-  const { info, queryParams, setQueryParams } = useApi.useApi();
+  const { path, info, queryParams, setQueryParams } = useApi.useApi();
   const schema = React.useMemo(() => {
     var _a2, _b2;
     return (_b2 = (_a2 = info == null ? void 0 : info.filters) == null ? void 0 : _a2[column.id]) == null ? void 0 : _b2.schema;
@@ -56,27 +81,29 @@ function ColumnHeaderFilterInput({
     [
       { value: field.getValue(), onChange: field.getInputProps().onChange },
       { value: column.getFilterValue(), onChange: column.setFilterValue },
+      ...withLocalStorage ? [
+        {
+          value: getLocalStorageValue(localStorageKey ?? `nextgen-datagrid-${path}-${column}`),
+          onChange: (value) => setLocalStorageValue(localStorageKey ?? `nextgen-datagrid-${path}-${column}`, value)
+        }
+      ] : [],
       ...filterState ? [filterState] : [],
       ...updateQueryParams ? [
         {
           value: (_b = (_a = queryParams == null ? void 0 : queryParams.filters) == null ? void 0 : _a.find((qpFilter) => qpFilter.id === column.id)) == null ? void 0 : _b.value,
           onChange: (value) => {
             setQueryParams((prev) => {
-              const newFilters = (prev == null ? void 0 : prev.filters) || [];
-              const newFilter = {
-                id: column.id,
-                col: column.id,
-                opr,
-                value
-              };
-              if (value === void 0) {
-                return { ...prev, filters: newFilters.filter((qpFilter) => qpFilter.id !== newFilter.id) };
-              }
-              const existingFilterIndex = newFilters.findIndex((qpFilter) => qpFilter.id === newFilter.id);
-              if (existingFilterIndex > -1) {
-                newFilters[existingFilterIndex] = newFilter;
+              let newFilters = [...(prev == null ? void 0 : prev.filters) ?? []];
+              const newFilter = { id: column.id, col: column.id, opr, value };
+              if (newFilter.value === void 0) {
+                newFilters = newFilters.filter((qpFilter) => qpFilter.id !== newFilter.id);
               } else {
-                newFilters.push(newFilter);
+                const existingFilterIndex = newFilters.findIndex((qpFilter) => qpFilter.id === newFilter.id);
+                if (existingFilterIndex > -1) {
+                  newFilters[existingFilterIndex] = newFilter;
+                } else {
+                  newFilters.push(newFilter);
+                }
               }
               return { ...prev, filters: newFilters };
             });

package/dist/core/cjs/Tables/NextGenDataGrid/hooks/useColumns/useColumns.cjs

@@ -36,6 +36,8 @@ function useColumns(columnProps, header, body, textFilterSeparator, enableAdvanc
         filterMenu,
         filterModeDescription,
         updateQueryParams = true,
+        withLocalStorage,
+        localStorageKey,
         defaultOpr = ((_d = (_c = (_b = (_a = info == null ? void 0 : info.filters) == null ? void 0 : _a[col]) == null ? void 0 : _b.filters) == null ? void 0 : _c[0]) == null ? void 0 : _d.operator) || ""
       } = utils.getProps(header, specialKey.all, col);
       const filterFn = utils.fromFilterToFilterFn(col, defaultOpr);
@@ -68,6 +70,8 @@ function useColumns(columnProps, header, body, textFilterSeparator, enableAdvanc
             filterMenu,
             filterModeDescription,
             updateQueryParams,
+            withLocalStorage,
+            localStorageKey,
             mrtProps: props,
             children: filterComponent
           }

package/dist/core/esm/Tables/NextGenDataGrid/hooks/useColumns/ColumnHeaderFilter.mjs

@@ -19,6 +19,8 @@ const ColumnHeaderFilter = ({
   filterMenu,
   filterModeDescription,
   updateQueryParams,
+  withLocalStorage,
+  localStorageKey,
   mrtProps
 }) => {
   var _a;
@@ -47,6 +49,8 @@ const ColumnHeaderFilter = ({
           filterState,
           filterSync,
           updateQueryParams,
+          withLocalStorage,
+          localStorageKey,
           filters,
           actionIconProps,
           filterProps,

package/dist/core/esm/Tables/NextGenDataGrid/hooks/useColumns/ColumnHeaderFilterInput/ColumnHeaderFilterInput.mjs

@@ -11,6 +11,29 @@ import { useApi } from "../../../../../hooks/api/useApi.mjs";
 import { getProps } from "../../../utils.mjs";
 import { getBasicInput } from "../utils.mjs";
 import { HeaderInput } from "./HeaderInput.mjs";
+const getLocalStorageValue = (key, defaultValue) => {
+  const value = localStorage.getItem(key);
+  if (value === null) {
+    return defaultValue;
+  }
+  try {
+    return JSON.parse(value);
+  } catch (e) {
+    console.error(`Error parsing localStorage value for key "${key}":`, e);
+    return defaultValue;
+  }
+};
+const setLocalStorageValue = (key, value) => {
+  if (value === void 0) {
+    localStorage.removeItem(key);
+  } else {
+    try {
+      localStorage.setItem(key, JSON.stringify(value));
+    } catch (e) {
+      console.error(`Error setting localStorage value for key "${key}":`, e);
+    }
+  }
+};
 const FilterIconWrapper = forwardRef(({ label, disabled, children, ...props }, ref) => {
   if (disabled) {
     return cloneElement(children, { ref });
@@ -38,13 +61,15 @@ function ColumnHeaderFilterInput({
   filterState,
   filterSync,
   updateQueryParams,
+  withLocalStorage,
+  localStorageKey,
   actionIconProps,
   functionProps,
   mrtProps
 }) {
   var _a, _b;
   const { column } = mrtProps;
-  const { info, queryParams, setQueryParams } = useApi();
+  const { path, info, queryParams, setQueryParams } = useApi();
   const schema = useMemo(() => {
     var _a2, _b2;
     return (_b2 = (_a2 = info == null ? void 0 : info.filters) == null ? void 0 : _a2[column.id]) == null ? void 0 : _b2.schema;
@@ -54,27 +79,29 @@ function ColumnHeaderFilterInput({
     [
       { value: field.getValue(), onChange: field.getInputProps().onChange },
       { value: column.getFilterValue(), onChange: column.setFilterValue },
+      ...withLocalStorage ? [
+        {
+          value: getLocalStorageValue(localStorageKey ?? `nextgen-datagrid-${path}-${column}`),
+          onChange: (value) => setLocalStorageValue(localStorageKey ?? `nextgen-datagrid-${path}-${column}`, value)
+        }
+      ] : [],
       ...filterState ? [filterState] : [],
       ...updateQueryParams ? [
         {
           value: (_b = (_a = queryParams == null ? void 0 : queryParams.filters) == null ? void 0 : _a.find((qpFilter) => qpFilter.id === column.id)) == null ? void 0 : _b.value,
           onChange: (value) => {
             setQueryParams((prev) => {
-              const newFilters = (prev == null ? void 0 : prev.filters) || [];
-              const newFilter = {
-                id: column.id,
-                col: column.id,
-                opr,
-                value
-              };
-              if (value === void 0) {
-                return { ...prev, filters: newFilters.filter((qpFilter) => qpFilter.id !== newFilter.id) };
-              }
-              const existingFilterIndex = newFilters.findIndex((qpFilter) => qpFilter.id === newFilter.id);
-              if (existingFilterIndex > -1) {
-                newFilters[existingFilterIndex] = newFilter;
+              let newFilters = [...(prev == null ? void 0 : prev.filters) ?? []];
+              const newFilter = { id: column.id, col: column.id, opr, value };
+              if (newFilter.value === void 0) {
+                newFilters = newFilters.filter((qpFilter) => qpFilter.id !== newFilter.id);
               } else {
-                newFilters.push(newFilter);
+                const existingFilterIndex = newFilters.findIndex((qpFilter) => qpFilter.id === newFilter.id);
+                if (existingFilterIndex > -1) {
+                  newFilters[existingFilterIndex] = newFilter;
+                } else {
+                  newFilters.push(newFilter);
+                }
               }
               return { ...prev, filters: newFilters };
             });

package/dist/core/esm/Tables/NextGenDataGrid/hooks/useColumns/useColumns.mjs

@@ -34,6 +34,8 @@ function useColumns(columnProps, header, body, textFilterSeparator, enableAdvanc
         filterMenu,
         filterModeDescription,
         updateQueryParams = true,
+        withLocalStorage,
+        localStorageKey,
         defaultOpr = ((_d = (_c = (_b = (_a = info == null ? void 0 : info.filters) == null ? void 0 : _a[col]) == null ? void 0 : _b.filters) == null ? void 0 : _c[0]) == null ? void 0 : _d.operator) || ""
       } = getProps(header, specialKey.all, col);
       const filterFn = fromFilterToFilterFn(col, defaultOpr);
@@ -66,6 +68,8 @@ function useColumns(columnProps, header, body, textFilterSeparator, enableAdvanc
             filterMenu,
             filterModeDescription,
             updateQueryParams,
+            withLocalStorage,
+            localStorageKey,
             mrtProps: props,
             children: filterComponent
           }

package/dist/core/lib/Tables/NextGenDataGrid/NextGenDataGrid.d.ts

@@ -71,6 +71,14 @@ export type NextGenDataGridHeaderProps = {
      * - Whether to update the query params when the filter is applied. Default is true
      */
     updateQueryParams?: boolean;
+    /**
+     * - Whether to store the filter state in local storage. Defaults to false
+     */
+    withLocalStorage?: boolean;
+    /**
+     * - The key to use for local storage when `withLocalStorage` is enabled. Defaults to `nextgen-datagrid-${path}-${column}` where `path` is the API path and `column` is the column name
+     */
+    localStorageKey?: string;
     /**
      * - Sets the default operator for the filter. The filter componenet may change based on the operator
      */

package/dist/core/lib/Tables/NextGenDataGrid/hooks/useColumns/ColumnHeaderFilter.d.ts

@@ -1,4 +1,4 @@
-export function ColumnHeaderFilter({ children, enableFilterModes, filters, filterFn, filterProps, filterState, filterSync, filterMenu, filterModeDescription, updateQueryParams, mrtProps, }: {
+export function ColumnHeaderFilter({ children, enableFilterModes, filters, filterFn, filterProps, filterState, filterSync, filterMenu, filterModeDescription, updateQueryParams, withLocalStorage, localStorageKey, mrtProps, }: {
     children: any;
     enableFilterModes: any;
     filters: any;
@@ -9,5 +9,7 @@ export function ColumnHeaderFilter({ children, enableFilterModes, filters, filte
     filterMenu: any;
     filterModeDescription: any;
     updateQueryParams: any;
+    withLocalStorage: any;
+    localStorageKey: any;
     mrtProps: any;
 }): import("react").JSX.Element;

package/dist/core/lib/Tables/NextGenDataGrid/hooks/useColumns/ColumnHeaderFilterInput/ColumnHeaderFilterInput.d.ts

@@ -1,4 +1,4 @@
-export function ColumnHeaderFilterInput({ children, opr, enableFilterModes, filters, filterProps, filterState, filterSync, updateQueryParams, actionIconProps, functionProps, mrtProps, }: {
+export function ColumnHeaderFilterInput({ children, opr, enableFilterModes, filters, filterProps, filterState, filterSync, updateQueryParams, withLocalStorage, localStorageKey, actionIconProps, functionProps, mrtProps, }: {
     children: any;
     opr: any;
     enableFilterModes: any;
@@ -7,6 +7,8 @@ export function ColumnHeaderFilterInput({ children, opr, enableFilterModes, filt
     filterState: any;
     filterSync: any;
     updateQueryParams: any;
+    withLocalStorage: any;
+    localStorageKey: any;
     actionIconProps: any;
     functionProps: any;
     mrtProps: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastapi-rtk",
-  "version": "0.1.35",
+  "version": "0.1.36",
   "private": false,
   "description": "A React component library for FastAPI in combination with FastAPI React Toolkit backend, built with Mantine, JsonForms, and Zustand.",
   "license": "MIT",