@redsift/table 12.5.4-muiv8-alpha.4 → 12.5.5-alpha.2

package/_internal/StatefulDataGrid.js

@@ -1,2 +1,2 @@
-export { aI as StatefulDataGrid } from './StatefulDataGrid2.js';
+export { aJ as StatefulDataGrid } from './StatefulDataGrid2.js';
 //# sourceMappingURL=StatefulDataGrid.js.map

package/_internal/StatefulDataGrid2.js

@@ -2289,6 +2289,29 @@ const getSearchParamsFromPivotActive = active => {
   searchParams.set('_pivotActive', String(active));
   return searchParams;
 };
+
+/**
+ * Builds the `v=<version>` search param the grid uses to detect stale URLs.
+ *
+ * Use this when constructing a deep link or share URL outside the grid (e.g. via
+ * `getSearchParamsFromFilterModel` + `buildQueryParamsString`). The grid itself
+ * always includes `v` in URLs it writes via `getFinalSearch`, but external helpers
+ * do not — include this when you want a stale `localStorageVersion` bump to invalidate
+ * the link. Omitting `v` is also safe: a missing `v` is treated as "current version"
+ * and the URL state is applied as-is.
+ *
+ * @example
+ * const params = new URLSearchParams([
+ *   ...getSearchParamsFromFilterModel(filterModel),
+ *   ...getSearchParamsFromVersion(1),
+ * ]);
+ * const url = `/my-grid${buildQueryParamsString(urlSearchParamsToString(params))}`;
+ */
+const getSearchParamsFromVersion = version => {
+  const searchParams = new URLSearchParams();
+  searchParams.set('v', String(version));
+  return searchParams;
+};
 const getPivotActive = (search, localStoragePivotActive, setLocalStoragePivotActive, initialState, isNewVersion) => {
   var _initialState$pivotin2, _initialState$pivotin3;
   const defaultValue = (_initialState$pivotin2 = initialState === null || initialState === void 0 ? void 0 : (_initialState$pivotin3 = initialState.pivoting) === null || _initialState$pivotin3 === void 0 ? void 0 : _initialState$pivotin3.enabled) !== null && _initialState$pivotin2 !== void 0 ? _initialState$pivotin2 : false;
@@ -2372,8 +2395,23 @@ const getModelsParsedOrUpdateLocalStorage = (search, localStorageVersion, column
   const decompressedSearch = decompressSearchParams(search);
   // Convert from display format (dot notation) to internal format (bracket notation) if needed
   const decodedSearch = getDecodedSearchFromUrl(decompressedSearch, columns);
-  const currentVersion = new URLSearchParams(decodedSearch).get('v');
-  const isNewVersion = !currentVersion || Number(currentVersion) !== localStorageVersion;
+  const decodedParams = new URLSearchParams(decodedSearch);
+  const currentVersion = decodedParams.get('v');
+  // Only treat as "new version reset" when the URL carries params AND explicitly declares a
+  // stale version (`v=` present but not matching `localStorageVersion`).
+  //
+  // Two cases that must NOT trigger a reset:
+  //   1. Empty URL — fall through to the localStorage branch of each getter so persisted
+  //      preferences are restored instead of being clobbered by defaults.
+  //   2. URL has params but no `v` — externally-constructed deep links / share links built
+  //      with `getSearchParamsFromFilterModel`, `buildQueryParamsString`, etc. do not include
+  //      `v` by default. Treating a missing `v` as "stale" silently discards the very state
+  //      the integrator just encoded into the URL (and wipes localStorage on the way out).
+  //      A missing `v` is interpreted as "current" so external URLs work out of the box.
+  //      URLs written by the grid itself (`getFinalSearch`) always include `v`, so a stale
+  //      bookmark from a previous `localStorageVersion` still resets correctly.
+  const hasUrlState = Array.from(decodedParams.keys()).length > 0;
+  const isNewVersion = hasUrlState && currentVersion != null && Number(currentVersion) !== localStorageVersion;
   const {
     localStorageFilters,
     setLocalStorageFilters,
@@ -3319,23 +3357,41 @@ const StatefulDataGrid = /*#__PURE__*/forwardRef((props, ref) => {
   }, [isDataSourceMode, onPaginationModelChange]);
 
   // In dataSource mode, pagination changes from our custom pagination slots
-  // (rendered outside MUI's pagination state) must:
-  //   1. Go through apiRef so MUI's internal page state updates and
-  //      dataSource.getRows() refetches with the new params.
-  //   2. Update URL/localStorage + local React state directly. We cannot rely
-  //      on MUI re-emitting onPaginationModelChange via apiRef.setPaginationModel
-  //      because in pivot/GroupedData strategy mode (and with paginationModel
-  //      passed via initialState rather than as a controlled prop) MUI does
-  //      not consistently fire the prop callback. The deep-equal guard in
-  //      useStatefulTable.onPaginationModelChange dedupes any re-emit MUI
-  //      does fire, so this is safe to call unconditionally.
+  // (rendered outside MUI's pagination state) route through apiRef so MUI's
+  // internal page state updates and dataSource.getRows() refetches with the
+  // new params. The `paginationModelChange` subscription below picks up the
+  // resulting state change and propagates it to URL/localStorage and local
+  // React state via wrappedOnPaginationModelChange.
   const dataSourcePaginationChange = useCallback(model => {
     var _apiRef$current;
     (_apiRef$current = apiRef.current) === null || _apiRef$current === void 0 ? void 0 : _apiRef$current.setPaginationModel(model);
-    wrappedOnPaginationModelChange(model, {
-      reason: 'setPaginationModel'
+  }, [apiRef]);
+
+  // In dataSource mode, subscribe to MUI's `paginationModelChange` event so
+  // URL state stays in sync with MUI's internal pagination regardless of how
+  // it changed (slot click, apiRef.setPaginationModel from consumer code,
+  // MUI internal updates, etc.). Relying on MUI's `onPaginationModelChange`
+  // prop callback alone is not sufficient: in pivot/GroupedData strategy mode
+  // and with `paginationModel` seeded via `initialState` (rather than as a
+  // controlled prop), the prop callback can be missed under certain
+  // re-render orderings. The event fires reliably whenever the internal
+  // state changes via `setState('setPaginationModel')`, see
+  // `useGridStateInitialization.setState` → `publishEvent(changeEvent, …)`.
+  // The deep-equal guard inside `useStatefulTable.onPaginationModelChange`
+  // dedupes any duplicate emits, so overlap with the prop callback is safe.
+  useEffect(() => {
+    if (!isDataSourceMode) return;
+    const api = apiRef.current;
+    if (!(api !== null && api !== void 0 && api.subscribeEvent)) return;
+    return api.subscribeEvent('paginationModelChange', model => {
+      wrappedOnPaginationModelChange({
+        page: model.page,
+        pageSize: model.pageSize
+      }, {
+        reason: 'paginationModelChange'
+      });
     });
-  }, [apiRef, wrappedOnPaginationModelChange]);
+  }, [isDataSourceMode, apiRef, wrappedOnPaginationModelChange]);
   const [rowSelectionModel, setRowSelectionModel] = useState(() => normalizeRowSelectionModel(propsRowSelectionModel));
   useEffect(() => {
     setRowSelectionModel(normalizeRowSelectionModel(propsRowSelectionModel));
@@ -3522,7 +3578,6 @@ const StatefulDataGrid = /*#__PURE__*/forwardRef((props, ref) => {
     onColumnWidthChange: onColumnWidthChange,
     onRowGroupingModelChange: onRowGroupingModelChange,
     onAggregationModelChange: onAggregationModelChange,
-    pivotModel: pivotModel,
     onPivotModelChange: onPivotModelChange,
     pivotActive: pivotActive,
     onPivotActiveChange: onPivotActiveChange
@@ -3530,11 +3585,16 @@ const StatefulDataGrid = /*#__PURE__*/forwardRef((props, ref) => {
     // onChange handlers are write-only for URL/localStorage persistence,
     // and initialState seeds MUI on mount from the persisted URL state.
     // columnVisibilityModel / pinnedColumns / rowGroupingModel /
-    // aggregationModel are also uncontrolled here to avoid a controlled
-    // re-render race with consumer-side microtask-deferred history
-    // updates (otherwise user toggles flip back when MUI re-emits with
-    // the stale controlled value). Consumers needing programmatic
-    // changes should use the apiRef imperative API.
+    // aggregationModel / pivotModel are also uncontrolled here to
+    // avoid a controlled re-render race with consumer-side
+    // microtask-deferred history updates (otherwise user toggles
+    // flip back when MUI re-emits with the stale controlled value).
+    // pivotModel specifically also carries `hidden`/`sort` field
+    // metadata that our simplified URL representation strips — so
+    // controlling it would prevent users from unchecking fields in
+    // the pivot panel (the controlled prop would immediately re-add
+    // them). Consumers needing programmatic changes should use the
+    // apiRef imperative API.
   }, isDataSourceMode ? {
     onFilterModelChange: onFilterModelChange,
     onSortModelChange: onSortModelChange,
@@ -3562,6 +3622,7 @@ const StatefulDataGrid = /*#__PURE__*/forwardRef((props, ref) => {
         paginationModel
       },
       pivoting: _objectSpread2(_objectSpread2({}, initialState === null || initialState === void 0 ? void 0 : initialState.pivoting), {}, {
+        model: pivotModel,
         enabled: pivotActive
       })
     })
@@ -3573,6 +3634,7 @@ const StatefulDataGrid = /*#__PURE__*/forwardRef((props, ref) => {
     filterModel,
     sortModel,
     paginationModel,
+    pivotModel,
     onFilterModelChange: onFilterModelChange,
     onSortModelChange: onSortModelChange,
     onPaginationModelChange: wrappedOnPaginationModelChange,
@@ -3753,5 +3815,5 @@ const StatefulDataGrid = /*#__PURE__*/forwardRef((props, ref) => {
 StatefulDataGrid.className = CLASSNAME;
 StatefulDataGrid.displayName = COMPONENT_NAME;
 
-export { buildStorageKey as $, ARRAY_IS_EMPTY as A, IS as B, CONTAINS_ANY_OF as C, DOES_NOT_CONTAIN as D, ENDS_WITH_ANY_OF as E, IS_NOT as F, getGridStringOperators as G, HAS_WITH_SELECT as H, IS_ANY_OF as I, getGridStringArrayOperators as J, getGridStringArrayOperatorsWithSelect as K, getGridStringArrayOperatorsWithSelectOnStringArrayColumns as L, FILTER_MODEL_KEY as M, SORT_MODEL_KEY as N, PINNED_COLUMNS as O, PAGINATION_MODEL_KEY as P, DIMENSION_MODEL_KEY as Q, FILTER_SEARCH_KEY as R, STARTS_WITH_ANY_OF as S, DENSITY_MODEL_KEY as T, COLUMN_ORDER_MODEL_KEY as U, VISIBILITY_MODEL_KEY as V, ROW_GROUPING_MODEL_KEY as W, AGGREGATION_MODEL_KEY as X, PIVOT_MODEL_KEY as Y, PIVOT_ACTIVE_KEY as Z, CATEGORIES as _, DOES_NOT_EQUAL as a, clearPreviousVersionStorage as a0, clearAllVersionStorage as a1, resetStatefulDataGridState as a2, convertToDisplayFormat as a3, convertFromDisplayFormat as a4, getDecodedSearchFromUrl as a5, buildQueryParamsString as a6, areSearchStringsEqual as a7, decodeValue as a8, encodeValue as a9, getPivotFromString as aA, getSearchParamsFromPivot as aB, getPivotActiveFromString as aC, getSearchParamsFromPivotActive as aD, getFinalSearch as aE, getModelsParsedOrUpdateLocalStorage as aF, updateUrl as aG, areFilterModelsEquivalent as aH, StatefulDataGrid as aI, urlSearchParamsToString as aa, numberOperatorEncoder as ab, numberOperatorDecoder as ac, isOperatorValueValid as ad, isValueValid as ae, getFilterModelFromString as af, getSearchParamsFromFilterModel as ag, getSortingFromString as ah, getSearchParamsFromSorting as ai, getPaginationFromString as aj, getSearchParamsFromPagination as ak, getColumnVisibilityFromString as al, getSearchParamsFromColumnVisibility as am, getPinnedColumnsFromString as an, getSearchParamsFromPinnedColumns as ao, getSearchParamsFromTab as ap, getDensityFromString as aq, getSearchParamsFromDensity as ar, getDensityModel as as, getColumnOrderFromString as at, getSearchParamsFromColumnOrder as au, getRowGroupingFromString as av, getSearchParamsFromRowGrouping as aw, getAggregationFromString as ax, getSearchParamsFromAggregation as ay, fromGridPivotModel as az, DOES_NOT_START_WITH as b, DOES_NOT_END_WITH as c, IS_NOT_ANY_OF as d, DOES_NOT_CONTAIN_ANY_OF as e, DOES_NOT_START_WITH_ANY_OF as f, DOES_NOT_END_WITH_ANY_OF as g, IS_BETWEEN as h, IS_WITH_SELECT as i, IS_NOT_WITH_SELECT as j, IS_ANY_OF_WITH_SELECT as k, IS_NOT_ANY_OF_WITH_SELECT as l, ARRAY_IS_NOT_EMPTY as m, DOES_NOT_HAVE_WITH_SELECT as n, operatorList as o, HAS_ANY_OF_WITH_SELECT as p, HAS_ALL_OF_WITH_SELECT as q, DOES_NOT_HAVE_ANY_OF_WITH_SELECT as r, HAS_ONLY_WITH_SELECT as s, HAS as t, DOES_NOT_HAVE as u, HAS_ANY_OF as v, HAS_ALL_OF as w, DOES_NOT_HAVE_ANY_OF as x, HAS_ONLY as y, getGridNumericOperators as z };
+export { buildStorageKey as $, ARRAY_IS_EMPTY as A, IS as B, CONTAINS_ANY_OF as C, DOES_NOT_CONTAIN as D, ENDS_WITH_ANY_OF as E, IS_NOT as F, getGridStringOperators as G, HAS_WITH_SELECT as H, IS_ANY_OF as I, getGridStringArrayOperators as J, getGridStringArrayOperatorsWithSelect as K, getGridStringArrayOperatorsWithSelectOnStringArrayColumns as L, FILTER_MODEL_KEY as M, SORT_MODEL_KEY as N, PINNED_COLUMNS as O, PAGINATION_MODEL_KEY as P, DIMENSION_MODEL_KEY as Q, FILTER_SEARCH_KEY as R, STARTS_WITH_ANY_OF as S, DENSITY_MODEL_KEY as T, COLUMN_ORDER_MODEL_KEY as U, VISIBILITY_MODEL_KEY as V, ROW_GROUPING_MODEL_KEY as W, AGGREGATION_MODEL_KEY as X, PIVOT_MODEL_KEY as Y, PIVOT_ACTIVE_KEY as Z, CATEGORIES as _, DOES_NOT_EQUAL as a, clearPreviousVersionStorage as a0, clearAllVersionStorage as a1, resetStatefulDataGridState as a2, convertToDisplayFormat as a3, convertFromDisplayFormat as a4, getDecodedSearchFromUrl as a5, buildQueryParamsString as a6, areSearchStringsEqual as a7, decodeValue as a8, encodeValue as a9, getPivotFromString as aA, getSearchParamsFromPivot as aB, getPivotActiveFromString as aC, getSearchParamsFromPivotActive as aD, getSearchParamsFromVersion as aE, getFinalSearch as aF, getModelsParsedOrUpdateLocalStorage as aG, updateUrl as aH, areFilterModelsEquivalent as aI, StatefulDataGrid as aJ, urlSearchParamsToString as aa, numberOperatorEncoder as ab, numberOperatorDecoder as ac, isOperatorValueValid as ad, isValueValid as ae, getFilterModelFromString as af, getSearchParamsFromFilterModel as ag, getSortingFromString as ah, getSearchParamsFromSorting as ai, getPaginationFromString as aj, getSearchParamsFromPagination as ak, getColumnVisibilityFromString as al, getSearchParamsFromColumnVisibility as am, getPinnedColumnsFromString as an, getSearchParamsFromPinnedColumns as ao, getSearchParamsFromTab as ap, getDensityFromString as aq, getSearchParamsFromDensity as ar, getDensityModel as as, getColumnOrderFromString as at, getSearchParamsFromColumnOrder as au, getRowGroupingFromString as av, getSearchParamsFromRowGrouping as aw, getAggregationFromString as ax, getSearchParamsFromAggregation as ay, fromGridPivotModel as az, DOES_NOT_START_WITH as b, DOES_NOT_END_WITH as c, IS_NOT_ANY_OF as d, DOES_NOT_CONTAIN_ANY_OF as e, DOES_NOT_START_WITH_ANY_OF as f, DOES_NOT_END_WITH_ANY_OF as g, IS_BETWEEN as h, IS_WITH_SELECT as i, IS_NOT_WITH_SELECT as j, IS_ANY_OF_WITH_SELECT as k, IS_NOT_ANY_OF_WITH_SELECT as l, ARRAY_IS_NOT_EMPTY as m, DOES_NOT_HAVE_WITH_SELECT as n, operatorList as o, HAS_ANY_OF_WITH_SELECT as p, HAS_ALL_OF_WITH_SELECT as q, DOES_NOT_HAVE_ANY_OF_WITH_SELECT as r, HAS_ONLY_WITH_SELECT as s, HAS as t, DOES_NOT_HAVE as u, HAS_ANY_OF as v, HAS_ALL_OF as w, DOES_NOT_HAVE_ANY_OF as x, HAS_ONLY as y, getGridNumericOperators as z };
 //# sourceMappingURL=StatefulDataGrid2.js.map