@redsift/table 11.1.3 → 11.2.0-muiv5

package/index.d.ts

@@ -1,6 +1,7 @@
 import * as _mui_x_data_grid_pro from '@mui/x-data-grid-pro';
-import { GridColumnTypesRecord, GridFilterItem, GridCellParams, GridFilterOperator, GridFilterInputValue, GridFilterInputMultipleValue, DataGridProProps, GridPinnedColumns, GridPaginationModel, GridFilterModel, GridSortModel, GridSortItem, GridColumnVisibilityModel, GridSlotsComponent, GridRowSelectionModel, GridApiPro as GridApiPro$1, GridRowParams, GridToolbarExportProps, GridToolbarFilterButtonProps, GridToolbarColumnsButton, GridToolbarDensitySelector } from '@mui/x-data-grid-pro';
-export { GridAlignment, GridColDef, GridFilterItem, GridFilterModel, getGridBooleanOperators, getGridDateOperators, getGridSingleSelectOperators } from '@mui/x-data-grid-pro';
+import { GridNativeColTypes, GridColumnTypesRecord, GridFilterItem, GridCellParams, GridFilterOperator, GridFilterInputValue, GridFilterInputMultipleValue, DataGridProProps, GridPinnedColumns, GridFilterModel, GridSortModel, GridSortItem, GridColumnVisibilityModel, GridSlotsComponent, GridSelectionModel, GridRowParams, GridToolbarExportProps, GridToolbarFilterButtonProps, GridToolbarColumnsButton, GridToolbarDensitySelector } from '@mui/x-data-grid-pro';
+export { GridAlignment, GridColDef, GridColumns, GridFilterItem, GridFilterModel, GridSelectionModel, getGridBooleanOperators, getGridDateOperators, getGridSingleSelectOperators } from '@mui/x-data-grid-pro';
+import { GridInitialStatePro } from '@mui/x-data-grid-pro/models/gridStatePro';
 import React, { ReactNode, ComponentProps, MutableRefObject, RefObject } from 'react';
 import { TablePaginationProps } from '@mui/material';
 import { Theme, Comp, IconProps, NotificationsColorPalette, ProductColorPalette, ShieldVariant } from '@redsift/design-system';
@@ -9,19 +10,19 @@ import { GridApiPro } from '@mui/x-data-grid-pro/models/gridApiPro';
 declare const DETAIL_PANEL_TOGGLE_COL_DEF: _mui_x_data_grid_pro.GridColDef<any, any, any>;
 
 declare const getRsStringColumnType: () => {
-    type: string;
+    extendType: GridNativeColTypes;
     filterOperators: _mui_x_data_grid_pro.GridFilterOperator<any, string | number | null, any>[];
 };
 declare const getRsNumberColumnType: () => {
-    type: string;
+    extendType: GridNativeColTypes;
     filterOperators: _mui_x_data_grid_pro.GridFilterOperator<any, string | number | null, any>[];
 };
-declare const customColumnTypes: Partial<GridColumnTypesRecord>;
+declare const customColumnTypes: GridColumnTypesRecord;
 
 declare const IS_BETWEEN: {
     label: string;
     value: string;
-    getApplyFilterFn: (filterItem: GridFilterItem) => ((params: GridCellParams<any, any>) => boolean) | null;
+    getApplyFilterFn: (filterItem: GridFilterItem) => ((params: GridCellParams) => boolean) | null;
     InputComponent: (props: any) => JSX.Element;
 };
 
@@ -90,8 +91,8 @@ declare const operatorList: {
     string: _mui_x_data_grid_pro.GridFilterOperator<any, string | number | null, any>[];
     number: _mui_x_data_grid_pro.GridFilterOperator<any, string | number | null, any>[];
     boolean: _mui_x_data_grid_pro.GridFilterOperator<any, boolean | null, any>[];
-    date: _mui_x_data_grid_pro.GridFilterOperator<any, Date, any>[];
-    dateTime: _mui_x_data_grid_pro.GridFilterOperator<any, Date, any>[];
+    date: _mui_x_data_grid_pro.GridFilterOperator<any, string | Date, any>[];
+    dateTime: _mui_x_data_grid_pro.GridFilterOperator<any, string | Date, any>[];
     singleSelect: _mui_x_data_grid_pro.GridFilterOperator<any, any, any>[];
     rsString: _mui_x_data_grid_pro.GridFilterOperator<any, string | number | null, any>[];
     rsNumber: _mui_x_data_grid_pro.GridFilterOperator<any, string | number | null, any>[];
@@ -131,6 +132,16 @@ interface DataGridProps extends Partial<Pick<DataGridProProps, 'rows'>>, Omit<Da
     paginationProps?: Omit<TablePaginationProps, 'component' | 'count' | 'page' | 'onPageChange' | 'rowsPerPage' | 'onRowsPerPageChange' | 'rowsPerPageOptions' | 'paginationMode'>;
     /** Theme. */
     theme?: Theme;
+    /** If set, the DataGrid configuration will be stored and synced in the URL and the local storage. useRouter prop should be defined. */
+    isStateful?: boolean;
+    /** Hook returning pathname, search params and a method to update query params. Used in stateful mode only. */
+    useRouter?: () => {
+        pathname: string;
+        search: string;
+        historyReplace: (newSearch: string) => void;
+    };
+    /** Pinned custom columns. */
+    pinnedCustomColumns?: Required<GridPinnedColumns>;
 }
 type SelectionStatus = {
     type: 'page' | 'table' | 'other' | 'none';
@@ -162,7 +173,9 @@ interface StatefulDataGridProps extends DataGridProps {
 
 declare const StatefulDataGrid: Comp<StatefulDataGridProps, HTMLDivElement>;
 
-interface ExtendedGridPaginationModel extends GridPaginationModel {
+interface ExtendedGridPaginationModel {
+    page: number;
+    pageSize: number;
     direction?: 'next' | 'back';
 }
 
@@ -172,8 +185,6 @@ declare const encodeValue: (value: string | undefined) => string;
 declare const urlSearchParamsToString: (searchParams: URLSearchParams) => string;
 declare const numberOperatorEncoder: Record<string, string>;
 declare const numberOperatorDecoder: Record<string, string>;
-declare const isOperatorValueValid: (field: string, operator: OperatorValue, columns: DataGridProps['columns']) => boolean;
-declare const isValueValid: (value: OperatorValue, field: string, columns: DataGridProps['columns'], operator: OperatorValue) => boolean;
 /** FILTERS */
 declare const getFilterModelFromString: (searchString: string, columns: DataGridProps['columns']) => GridFilterModel | 'invalid';
 declare const getSearchParamsFromFilterModel: (filterModel: GridFilterModel) => URLSearchParams;
@@ -223,7 +234,7 @@ type ModelsTable = {
     pinnedColumnsModel: PinnedColumns;
 };
 /** Return the state of the table given the URL and the local storage state */
-declare const getModelsParsedOrUpdateLocalStorage: (search: string, columns: DataGridProps['columns'], historyReplace: (newSearch: string) => void, localStorage: ModelsLocalStorage) => ModelsTable;
+declare const getModelsParsedOrUpdateLocalStorage: (search: string, columns: DataGridProps['columns'], historyReplace: (newSearch: string) => void, initialState: GridInitialStatePro | undefined, localStorage: ModelsLocalStorage) => ModelsTable;
 type DataGridModel = {
     filterModel: GridFilterModel;
     sortModel: GridSortModel;
@@ -246,12 +257,12 @@ declare const BasePopper: React.JSXElementConstructor<any>;
 declare const BaseTextField: React.JSXElementConstructor<any>;
 
 interface CompletionResponseItem {
-    field: string;
-    operator: string;
+    columnField: string;
+    operatorValue: string;
     value?: string;
 }
 type CompletionResponse = {
-    logicOperator: 'and' | 'or';
+    linkOperator: 'and' | 'or';
     items: CompletionResponseItem[];
 };
 interface LocaleText {
@@ -297,9 +308,11 @@ type ControlledPaginationProps = {
     displayPagination?: boolean;
     selectionStatus: SelectionStatus;
     apiRef: MutableRefObject<GridApiPro>;
-    paginationModel: GridPaginationModel;
-    onPaginationModelChange: (model: GridPaginationModel) => void;
-    pageSizeOptions?: number[];
+    page: number;
+    onPageChange: (page: number) => void;
+    pageSize: number;
+    onPageSizeChange: (pageSize: number) => void;
+    rowsPerPageOptions?: number[];
     isRowSelectable?: DataGridProps['isRowSelectable'];
     paginationProps?: DataGridProps['paginationProps'];
 };
@@ -310,14 +323,16 @@ type ServerSideControlledPaginationProps = {
     displayRowsPerPage?: boolean;
     displayPagination?: boolean;
     selectionStatus: SelectionStatus;
-    paginationModel: GridPaginationModel;
-    onPaginationModelChange: (model: GridPaginationModel) => void;
-    pageSizeOptions?: number[];
+    page: number;
+    onPageChange: (page: number) => void;
+    pageSize: number;
+    onPageSizeChange: (pageSize: number) => void;
+    rowsPerPageOptions?: number[];
     paginationProps?: DataGridProps['paginationProps'];
     rowCount: number;
     loading?: boolean;
 };
-declare const onServerSideSelectionStatusChange: (newSelectionModel: GridRowSelectionModel, apiRef: React.MutableRefObject<GridApiPro$1>, selectionStatus: React.MutableRefObject<SelectionStatus>, isRowSelectable: ((params: GridRowParams<any>) => boolean) | undefined, page: number, pageSize: number) => void;
+declare const onServerSideSelectionStatusChange: (newSelectionModel: GridSelectionModel, apiRef: React.MutableRefObject<GridApiPro>, selectionStatus: React.MutableRefObject<SelectionStatus>, isRowSelectable: ((params: GridRowParams<any>) => boolean) | undefined, page: number, pageSize: number) => void;
 declare const ServerSideControlledPagination: React.FC<ServerSideControlledPaginationProps>;
 
 interface TextCellProps extends ComponentProps<'div'> {
@@ -405,13 +420,15 @@ type ToolbarWrapperProps = {
     selectionStatus: React.MutableRefObject<SelectionStatus>;
     apiRef: DataGridProps['apiRef'];
     isRowSelectable: DataGridProps['isRowSelectable'];
-    paginationModel: DataGridProps['paginationModel'];
-    onPaginationModelChange: DataGridProps['onPaginationModelChange'];
-    pageSizeOptions: DataGridProps['pageSizeOptions'];
+    page: DataGridProps['page'];
+    onPageChange: DataGridProps['onPageChange'];
+    pageSize: DataGridProps['pageSize'];
+    onPageSizeChange: DataGridProps['onPageSizeChange'];
+    rowsPerPageOptions: DataGridProps['rowsPerPageOptions'];
     paginationProps: DataGridProps['paginationProps'];
     paginationMode?: DataGridProps['paginationMode'];
     rowCount?: DataGridProps['rowCount'];
 };
 declare const ToolbarWrapper: React.FC<ToolbarWrapperProps>;
 
-export { BaseButton, BaseCheckbox, BaseIcon, BasePopper, BaseTextField, CATEGORIES, CONTAINS_ANY_OF, CONTAINS_ANY_OF_I, Category, CompletionResponse, ControlledPagination, ControlledPaginationProps, DEFAULT_OPERATORS, DETAIL_PANEL_TOGGLE_COL_DEF, DIMENSION_MODEL_KEY, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, DataGrid, DataGridModel, DataGridProps, ENDS_WITH_ANY_OF, FILTER_MODEL_KEY, FILTER_SEARCH_KEY, FilterConfig, GridToolbarFilterSemanticField, GridToolbarFilterSemanticFieldProps, IS_ANY_OF, IS_BETWEEN, IS_NOT_ANY_OF, PAGINATION_MODEL_KEY, PINNED_COLUMNS, PinnedColumns, SORT_MODEL_KEY, STARTS_WITH_ANY_OF, SelectionStatus, ServerSideControlledPagination, ServerSideControlledPaginationProps, StatefulDataGrid, StatefulDataGridProps, StyledDataGridProps, TextCell, Toolbar, ToolbarWrapper, ToolbarWrapperProps, VISIBILITY_MODEL_KEY, areFilterModelsEquivalent, buildStorageKey, clearPreviousVersionStorage, customColumnTypes, decodeValue, encodeValue, getColumnVisibilityFromString, getCompletion, getFilterModelFromString, getFinalSearch, getGridNumericOperators, getGridStringArrayOperators, getGridStringOperators, getModelsParsedOrUpdateLocalStorage, getPaginationFromString, getPinnedColumnsFromString, getRsNumberColumnType, getRsStringColumnType, getSearchParamsFromColumnVisibility, getSearchParamsFromFilterModel, getSearchParamsFromPagination, getSearchParamsFromPinnedColumns, getSearchParamsFromSorting, getSearchParamsFromTab, getSortingFromString, isOperatorValueValid, isValueValid, muiIconToDSIcon, numberOperatorDecoder, numberOperatorEncoder, onServerSideSelectionStatusChange, operatorList, updateUrl, urlSearchParamsToString };
+export { BaseButton, BaseCheckbox, BaseIcon, BasePopper, BaseTextField, CATEGORIES, CONTAINS_ANY_OF, CONTAINS_ANY_OF_I, Category, CompletionResponse, ControlledPagination, ControlledPaginationProps, DEFAULT_OPERATORS, DETAIL_PANEL_TOGGLE_COL_DEF, DIMENSION_MODEL_KEY, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, DataGrid, DataGridModel, DataGridProps, ENDS_WITH_ANY_OF, FILTER_MODEL_KEY, FILTER_SEARCH_KEY, FilterConfig, GridToolbarFilterSemanticField, GridToolbarFilterSemanticFieldProps, IS_ANY_OF, IS_BETWEEN, IS_NOT_ANY_OF, PAGINATION_MODEL_KEY, PINNED_COLUMNS, PinnedColumns, SORT_MODEL_KEY, STARTS_WITH_ANY_OF, SelectionStatus, ServerSideControlledPagination, ServerSideControlledPaginationProps, StatefulDataGrid, StatefulDataGridProps, StyledDataGridProps, TextCell, Toolbar, ToolbarWrapper, ToolbarWrapperProps, VISIBILITY_MODEL_KEY, areFilterModelsEquivalent, buildStorageKey, clearPreviousVersionStorage, customColumnTypes, decodeValue, encodeValue, getColumnVisibilityFromString, getCompletion, getFilterModelFromString, getFinalSearch, getGridNumericOperators, getGridStringArrayOperators, getGridStringOperators, getModelsParsedOrUpdateLocalStorage, getPaginationFromString, getPinnedColumnsFromString, getRsNumberColumnType, getRsStringColumnType, getSearchParamsFromColumnVisibility, getSearchParamsFromFilterModel, getSearchParamsFromPagination, getSearchParamsFromPinnedColumns, getSearchParamsFromSorting, getSearchParamsFromTab, getSortingFromString, muiIconToDSIcon, numberOperatorDecoder, numberOperatorEncoder, onServerSideSelectionStatusChange, operatorList, updateUrl, urlSearchParamsToString };