@infinite-table/infinite-react 0.6.3 → 0.7.0

package/index.d.ts

@@ -106,6 +106,7 @@ declare function useInfiniteHeaderCell<T>(): {
     allRowsSelected: boolean;
     someRowsSelected: boolean;
     api: InfiniteTableApi<T>;
+    columnApi: InfiniteTableColumnApi<T>;
     renderBag: {
         all?: Renderable;
         header: Renderable;
@@ -166,6 +167,16 @@ type DiscriminatedUnion<A, B> = (A & {
 });
 type KeyOfNoSymbol<T> = Exclude<keyof T, Symbol>;
 
+type MenuIconProps = {
+    lineWidth?: number;
+    lineStyle?: React$1.CSSProperties;
+    style?: React$1.CSSProperties;
+    className?: string;
+    domProps?: React$1.HTMLAttributes<HTMLDivElement>;
+    reserveSpaceWhenHidden?: boolean;
+    children?: React$1.ReactNode;
+};
+
 type InfiniteTableToggleGroupRowFn = (groupKeys: any[]) => void;
 type InfiniteTableSelectRowFn = (id: any) => void;
 type InfiniteTableColumnHeaderParam<DATA_TYPE, COL_TYPE = InfiniteTableComputedColumn<DATA_TYPE>> = {
@@ -178,6 +189,7 @@ type InfiniteTableColumnHeaderParam<DATA_TYPE, COL_TYPE = InfiniteTableComputedC
     allRowsSelected: boolean;
     someRowsSelected: boolean;
     api: InfiniteTableApi<DATA_TYPE>;
+    columnApi: InfiniteTableColumnApi<DATA_TYPE>;
     renderBag: {
         all?: Renderable;
         header: string | number | Renderable;
@@ -329,6 +341,7 @@ type InfiniteTableColumn<DATA_TYPE> = {
     components?: {
         ColumnCell?: React.FunctionComponent<HTMLProps<HTMLDivElement>>;
         HeaderCell?: React.FunctionComponent<HTMLProps<HTMLDivElement>>;
+        MenuIcon?: React.FC<MenuIconProps>;
     };
 };
 type InfiniteTableGeneratedGroupColumn<T> = Omit<InfiniteTableColumn<T>, 'sortable'> & {
@@ -987,7 +1000,7 @@ interface InfiniteTableSetupState<T> {
     activeCellIndicatorDOMRef: MutableRefObject<HTMLDivElement | null>;
     onRowHeightCSSVarChange: SubscriptionCallback<number>;
     onColumnMenuClick: SubscriptionCallback<{
-        target: HTMLElement;
+        target: HTMLElement | EventTarget;
         column: InfiniteTableComputedColumn<T>;
     }>;
     columnContextMenuVisibleForColumnId: string | null;
@@ -1105,6 +1118,7 @@ interface InfiniteTableContextValue<T> {
     imperativeApi: InfiniteTableApi<T>;
     componentState: InfiniteTableState<T>;
     componentActions: InfiniteTableActions<T>;
+    dataSourceActions: DataSourceComponentActions<T>;
     computed: InfiniteTableComputedValues<T>;
     getComputed: () => InfiniteTableComputedValues<T>;
     getState: () => InfiniteTableState<T>;
@@ -1123,6 +1137,37 @@ type RenderRange = {
     renderEndIndex: number;
 };
 
+type DataSourceMutation<T> = {
+    type: 'delete';
+    primaryKey: any;
+} | {
+    type: 'update';
+    primaryKey: any;
+    data: Partial<T>;
+} | {
+    type: 'insert';
+    primaryKey: any;
+    position: 'before' | 'after';
+    data: T;
+};
+declare class DataSourceCache<DataType, PrimaryKeyType = string> {
+    private affectedFields;
+    private allFieldsAffected;
+    private primaryKeyToData;
+    static clone<DataType, PrimaryKeyType = string>(cache: DataSourceCache<DataType, PrimaryKeyType>, { light }?: {
+        light?: boolean;
+    }): DataSourceCache<DataType, PrimaryKeyType>;
+    getAffectedFields: () => true | Set<keyof DataType>;
+    delete: (primaryKey: PrimaryKeyType) => void;
+    insert: (primaryKey: PrimaryKeyType, data: DataType, position: 'before' | 'after') => void;
+    update: (primaryKey: PrimaryKeyType, data: Partial<DataType>) => void;
+    clear: () => void;
+    isEmpty: () => boolean;
+    removeInfo: (primaryKey: PrimaryKeyType) => void;
+    getMutationsForPrimaryKey: (primaryKey: PrimaryKeyType) => DataSourceMutation<DataType>[] | undefined;
+    getMutations: () => Map<string, DataSourceMutation<DataType>[]>;
+}
+
 type BooleanDeepCollectionStateKeys<KeyType> = true | KeyType[][];
 type BooleanDeepCollectionStateObject<KeyType> = {
     positiveItems: BooleanDeepCollectionStateKeys<KeyType>;
@@ -1172,10 +1217,13 @@ declare class GroupRowsState<KeyType extends any = any> extends BooleanDeepColle
 
 declare class Indexer<DataType, PrimaryKeyType = string> {
     primaryKeyToData: Map<string, DataType>;
-    add: (primaryKey: PrimaryKeyType, data: DataType) => void;
+    private add;
     clear: () => void;
-    getDataForPrimaryKey: (primaryKey: PrimaryKeyType) => DataType | undefined;
-    indexArray: (arr: DataType[], toPrimaryKey: (data: DataType) => PrimaryKeyType) => void;
+    getDataForPrimaryKey: (primaryKey: PrimaryKeyType | string) => DataType | undefined;
+    indexArray: (arr: DataType[], options: {
+        toPrimaryKey: (data: DataType) => PrimaryKeyType;
+        cache?: DataSourceCache<DataType, string> | undefined;
+    }) => DataType[];
 }
 
 interface DataSourceDataParams<T> {
@@ -1184,6 +1232,7 @@ interface DataSourceDataParams<T> {
     groupBy?: DataSourcePropGroupBy<T>;
     pivotBy?: DataSourcePropPivotBy<T>;
     filterValue?: DataSourcePropFilterValue<T>;
+    refetchKey?: DataSourceProps<T>['refetchKey'];
     groupRowsState?: DataSourcePropGroupRowsStateObject<any>;
     lazyLoadBatchSize?: number;
     lazyLoadStartIndex?: number;
@@ -1223,8 +1272,11 @@ type DataSourcePropPivotBy<T> = DataSourcePivotBy<T>[];
 interface DataSourceMappedState<T> {
     aggregationReducers?: DataSourceProps<T>['aggregationReducers'];
     livePagination: DataSourceProps<T>['livePagination'];
+    refetchKey: NonUndefined<DataSourceProps<T>['refetchKey']>;
     isRowSelected: DataSourceProps<T>['isRowSelected'];
     onDataArrayChange: DataSourceProps<T>['onDataArrayChange'];
+    onDataMutations: DataSourceProps<T>['onDataMutations'];
+    onReady: DataSourceProps<T>['onReady'];
     lazyLoad: DataSourceProps<T>['lazyLoad'];
     useGroupKeysForMultiRowSelection: NonUndefined<DataSourceProps<T>['useGroupKeysForMultiRowSelection']>;
     onDataParamsChange: DataSourceProps<T>['onDataParamsChange'];
@@ -1283,10 +1335,14 @@ type LazyRowInfoGroup<DataType> = {
 type LazyGroupDataDeepMap<DataType, KeyType = string> = DeepMap<KeyType, LazyRowInfoGroup<DataType>>;
 interface DataSourceSetupState<T> {
     indexer: Indexer<T, any>;
+    cache?: DataSourceCache<T>;
     unfilteredCount: number;
     filteredCount: number;
     originalDataArrayChanged: boolean;
-    originalDataArrayChangedAt: number;
+    originalDataArrayChangedInfo: {
+        timestamp: number;
+        mutations?: Map<string, DataSourceMutation<T>[]>;
+    };
     lazyLoadCacheOfLoadedBatches: DeepMap<string, true>;
     pivotMappings?: DataSourceMappings;
     propsCache: Map<keyof DataSourceProps<T>, WeakMap<any, any>>;
@@ -1335,10 +1391,34 @@ type DataSourcePropOnRowSelectionChange_SingleRow = (rowSelection: DataSourcePro
 type DataSourcePropOnRowSelectionChange = DataSourcePropOnRowSelectionChange_SingleRow | DataSourcePropOnRowSelectionChange_MultiRow;
 type DataSourcePropOnCellSelectionChange = (cellSelectionParams: any) => void;
 type DataSourcePropIsRowSelected<T> = (rowInfo: InfiniteTableRowInfo<T>, rowSelectionState: RowSelectionState, selectionMode: 'multi-row') => boolean | null;
+type DataSourceCRUDParam = {
+    flush?: boolean;
+};
+type DataSourceInsertParam = DataSourceCRUDParam & ({
+    position: 'before' | 'after';
+    primaryKey: any;
+} | {
+    position: 'start' | 'end';
+});
+interface DataSourceApi<T> {
+    getRowInfoArray: () => InfiniteTableRowInfo<T>[];
+    getDataByPrimaryKey(id: any): T | undefined;
+    updateData(data: Partial<T>, options?: DataSourceCRUDParam): void;
+    updateDataArray(data: Partial<T>[], options?: DataSourceCRUDParam): void;
+    removeDataByPrimaryKey(id: any, options?: DataSourceCRUDParam): void;
+    removeDataArrayByPrimaryKeys(id: any[], options?: DataSourceCRUDParam): void;
+    removeData(data: Partial<T>, options?: DataSourceCRUDParam): void;
+    removeDataArray(data: Partial<T>[], options?: DataSourceCRUDParam): void;
+    addData(data: T, options?: DataSourceCRUDParam): void;
+    addDataArray(data: T[], options?: DataSourceCRUDParam): void;
+    insertData(data: T, options: DataSourceInsertParam): void;
+    insertDataArray(data: T[], options: DataSourceInsertParam): void;
+}
 type DataSourceProps<T> = {
     children: React$1.ReactNode | ((contextData: DataSourceState<T>) => React$1.ReactNode);
     primaryKey: keyof T | ((data: T) => string);
     fields?: (keyof T)[];
+    refetchKey?: number | string | object;
     data: DataSourceData<T>;
     selectionMode?: DataSourcePropSelectionMode;
     useGroupKeysForMultiRowSelection?: boolean;
@@ -1354,6 +1434,7 @@ type DataSourceProps<T> = {
     loading?: boolean;
     defaultLoading?: boolean;
     onLoadingChange?: (loading: boolean) => void;
+    onReady?: (api: DataSourceApi<T>) => void;
     pivotBy?: DataSourcePropPivotBy<T>;
     defaultPivotBy?: DataSourcePropPivotBy<T>;
     onPivotByChange?: (pivotBy: DataSourcePropPivotBy<T>) => void;
@@ -1370,7 +1451,12 @@ type DataSourceProps<T> = {
     defaultSortInfo?: DataSourceSortInfo<T>;
     onSortInfoChange?: ((sortInfo: DataSourceSingleSortInfo<T> | null) => void) | ((sortInfo: DataSourceSingleSortInfo<T>[]) => void);
     onDataParamsChange?: (dataParamsChange: DataSourceDataParams<T>) => void;
-    onDataArrayChange?: (dataArray: DataSourceState<T>['originalDataArray']) => void;
+    onDataArrayChange?: (dataArray: DataSourceState<T>['originalDataArray'], info: DataSourceState<T>['originalDataArrayChangedInfo']) => void;
+    onDataMutations?: ({ dataArray, timestamp, mutations, }: {
+        dataArray: DataSourceState<T>['originalDataArray'];
+        timestamp: number;
+        mutations: NonUndefined<DataSourceState<T>['originalDataArrayChangedInfo']['mutations']>;
+    }) => void;
     livePagination?: boolean;
     livePaginationCursor?: DataSourcePropLivePaginationCursor<T>;
     onLivePaginationCursorChange?: (livePaginationCursor: DataSourceLivePaginationCursorValue) => void;
@@ -1464,6 +1550,7 @@ type DataSourceDerivedState<T> = {
 };
 type DataSourceComponentActions<T> = ComponentStateActions<DataSourceState<T>>;
 interface DataSourceContextValue<T> {
+    api: DataSourceApi<T>;
     getState: () => DataSourceState<T>;
     componentState: DataSourceState<T>;
     componentActions: DataSourceComponentActions<T>;
@@ -2044,6 +2131,14 @@ type InfiniteTableColumnSizingOptions = {
     maxWidth?: number;
 };
 type InfiniteTablePropColumnSizing = Record<string, InfiniteTableColumnSizingOptions>;
+type InfiniteTableColumnApi<_T> = {
+    showContextMenu: (target: EventTarget | HTMLElement) => void;
+    toggleContextMenu: (target: EventTarget | HTMLElement) => void;
+    hideContextMenu: () => void;
+    toggleSort: () => void;
+    clearSort: () => void;
+    setSort: (sort: SortDir | null) => void;
+};
 type InfiniteTableApi<T> = {
     get selectionApi(): InfiniteTableSelectionApi;
     setColumnOrder: (columnOrder: InfiniteTablePropColumnOrder) => void;
@@ -2053,6 +2148,10 @@ type InfiniteTableApi<T> = {
     set scrollLeft(value: number);
     get scrollTop(): number;
     set scrollTop(value: number);
+    getVerticalRenderRange: () => {
+        renderStartIndex: number;
+        renderEndIndex: number;
+    };
     toggleGroupRow: (groupKeys: any[]) => void;
     collapseGroupRow: (groupKeys: any[]) => boolean;
     expandGroupRow: (groupKeys: any[]) => boolean;
@@ -2129,6 +2228,7 @@ type InfiniteTablePropComponents = {
     LoadMask?: React$1.FC<React$1.PropsWithChildren<LoadMaskProps>>;
     CheckBox?: React$1.FC<InfiniteCheckBoxProps>;
     Menu?: React$1.FC<React$1.PropsWithChildren<MenuProps>>;
+    MenuIcon?: React$1.FC<MenuIconProps>;
 };
 type ScrollStopInfo = {
     scrollTop: number;
@@ -2246,7 +2346,10 @@ interface InfiniteTableProps<T> {
     onColumnOrderChange?: (columnOrder: InfiniteTablePropColumnOrderNormalized) => void;
     onRowHeightChange?: (rowHeight: number) => void;
     filterEditors?: InfiniteTablePropFilterEditors<T>;
-    onReady?: (api: InfiniteTableApi<T>) => void;
+    onReady?: ({ api, dataSourceApi, }: {
+        api: InfiniteTableApi<T>;
+        dataSourceApi: DataSourceApi<T>;
+    }) => void;
     rowProps?: React$1.HTMLProps<HTMLDivElement> | ((rowArgs: InfiniteTableRowStyleFnParams<T>) => React$1.HTMLProps<HTMLDivElement>);
     licenseKey?: string;
     scrollTopKey?: string | number;
@@ -2351,4 +2454,4 @@ declare const components: {
     LoadMask: (props: LoadMaskProps) => JSX.Element;
 };
 
-export { AdvancedAlignable, ColumnTypeWithInherit, DataSource, DataSourceAction, DataSourceActionType, DataSourceAggregationReducer, DataSourceComponentActions, DataSourceContextValue, DataSourceData, DataSourceDataParams, DataSourceDataParamsChanges, DataSourceDerivedState, DataSourceFilterFunctionParam, DataSourceFilterOperator, DataSourceFilterOperatorFunction, DataSourceFilterOperatorFunctionParam, DataSourceFilterType, DataSourceFilterValueItem, DataSourceFilterValueItemValueGetter, DataSourceGroupBy, DataSourceGroupRowsList, DataSourceLivePaginationCursorFn, DataSourceLivePaginationCursorParams, DataSourceLivePaginationCursorValue, DataSourceMappedState, DataSourceMappings, DataSourcePivotBy, DataSourcePropAggregationReducers, DataSourcePropCellSelection, DataSourcePropFilterFunction, DataSourcePropFilterTypes, DataSourcePropFilterValue, DataSourcePropGroupBy, DataSourcePropGroupRowsStateObject, DataSourcePropIsRowSelected, DataSourcePropLivePaginationCursor, DataSourcePropMultiRowSelectionChangeParamType, DataSourcePropOnCellSelectionChange, DataSourcePropOnRowSelectionChange, DataSourcePropOnRowSelectionChange_MultiRow, DataSourcePropOnRowSelectionChange_SingleRow, DataSourcePropPivotBy, DataSourcePropRowSelection, DataSourcePropRowSelection_MultiRow, DataSourcePropRowSelection_SingleRow, DataSourcePropSelectionMode, DataSourcePropSortInfo, DataSourcePropSortTypes, DataSourceProps, DataSourceReducer, DataSourceRemoteData, DataSourceSetupState, DataSourceSingleSortInfo, DataSourceSortInfo, DataSourceState, ElementContainerGetter, GroupRowsState, InfiniteTable, InfiniteTableAction, InfiniteTableActionType, InfiniteTableApi, InfiniteTableClassName, InfiniteTableColumn, InfiniteTableColumnAggregator, InfiniteTableColumnComparer, InfiniteTableColumnGroup, InfiniteTableColumnRenderFunctionForGroupRows, InfiniteTableColumnRenderFunctionForNormalRows, InfiniteTableColumnRenderParam, InfiniteTableColumnRenderValueParam, InfiniteTableColumnRowspanParam, InfiniteTableColumnSizingOptions, InfiniteTableColumnsMap, InfiniteTableComponent, InfiniteTableComputedColumn, InfiniteTableComputedValues, InfiniteTableContextValue, InfiniteTableFilterEditorProps, InfiniteTableGroupColumnBase, InfiniteTableGroupColumnFunction, InfiniteTableGroupColumnGetterOptions, InfiniteTablePivotColumn, InfiniteTablePropAutoSizeColumnsKey, InfiniteTablePropColumnGroups, InfiniteTablePropColumnOrder, InfiniteTablePropColumnPinning, InfiniteTablePropColumnSizing, InfiniteTablePropColumnTypes, InfiniteTablePropColumnVisibility, InfiniteTablePropColumns, InfiniteTablePropComponents, InfiniteTablePropFilterEditors, InfiniteTablePropGetColumnContextMenuItems, InfiniteTablePropGroupColumn, InfiniteTablePropGroupRenderStrategy, InfiniteTablePropHeaderOptions, InfiniteTablePropKeyboardNavigation, InfiniteTablePropRowClassName, InfiniteTablePropRowStyle, InfiniteTableProps, InfiniteTableRowClassNameFn, InfiniteTableRowInfo, InfiniteTableRowStyleFn, InfiniteTableState, LazyGroupDataDeepMap, LazyGroupDataItem, LazyRowInfoGroup, Menu, MenuChildrenFnParam, MenuColumn, MenuColumnRenderParam, MenuDecoration, MenuItemDefinition, MenuItemObject, MenuProps, MenuRenderable, MenuRuntimeItem, MenuRuntimeItemSelectable, MenuSeparator, NumberFilterEditor, OverlayShowParams, RowSelectionState, Scrollbars, StringFilterEditor, components, debounce, defaultFilterEditors, defaultFilterTypes, defaultFilterTypes as filterTypes, flatten, getComponentStateRoot, group, interceptMap, multisort, useComponentState, useDataSource, useEffectWithChanges, useInfiniteColumnCell, useInfiniteHeaderCell, useOverlay, useOverlayPortal };
+export { AdvancedAlignable, ColumnTypeWithInherit, DataSource, DataSourceAction, DataSourceActionType, DataSourceAggregationReducer, DataSourceApi, DataSourceCRUDParam, DataSourceComponentActions, DataSourceContextValue, DataSourceData, DataSourceDataParams, DataSourceDataParamsChanges, DataSourceDerivedState, DataSourceFilterFunctionParam, DataSourceFilterOperator, DataSourceFilterOperatorFunction, DataSourceFilterOperatorFunctionParam, DataSourceFilterType, DataSourceFilterValueItem, DataSourceFilterValueItemValueGetter, DataSourceGroupBy, DataSourceGroupRowsList, DataSourceInsertParam, DataSourceLivePaginationCursorFn, DataSourceLivePaginationCursorParams, DataSourceLivePaginationCursorValue, DataSourceMappedState, DataSourceMappings, DataSourcePivotBy, DataSourcePropAggregationReducers, DataSourcePropCellSelection, DataSourcePropFilterFunction, DataSourcePropFilterTypes, DataSourcePropFilterValue, DataSourcePropGroupBy, DataSourcePropGroupRowsStateObject, DataSourcePropIsRowSelected, DataSourcePropLivePaginationCursor, DataSourcePropMultiRowSelectionChangeParamType, DataSourcePropOnCellSelectionChange, DataSourcePropOnRowSelectionChange, DataSourcePropOnRowSelectionChange_MultiRow, DataSourcePropOnRowSelectionChange_SingleRow, DataSourcePropPivotBy, DataSourcePropRowSelection, DataSourcePropRowSelection_MultiRow, DataSourcePropRowSelection_SingleRow, DataSourcePropSelectionMode, DataSourcePropSortInfo, DataSourcePropSortTypes, DataSourceProps, DataSourceReducer, DataSourceRemoteData, DataSourceSetupState, DataSourceSingleSortInfo, DataSourceSortInfo, DataSourceState, ElementContainerGetter, GroupRowsState, InfiniteTable, InfiniteTableAction, InfiniteTableActionType, InfiniteTableApi, InfiniteTableClassName, InfiniteTableColumn, InfiniteTableColumnAggregator, InfiniteTableColumnApi, InfiniteTableColumnComparer, InfiniteTableColumnGroup, InfiniteTableColumnRenderFunctionForGroupRows, InfiniteTableColumnRenderFunctionForNormalRows, InfiniteTableColumnRenderParam, InfiniteTableColumnRenderValueParam, InfiniteTableColumnRowspanParam, InfiniteTableColumnSizingOptions, InfiniteTableColumnsMap, InfiniteTableComponent, InfiniteTableComputedColumn, InfiniteTableComputedValues, InfiniteTableContextValue, InfiniteTableFilterEditorProps, InfiniteTableGroupColumnBase, InfiniteTableGroupColumnFunction, InfiniteTableGroupColumnGetterOptions, InfiniteTablePivotColumn, InfiniteTablePropAutoSizeColumnsKey, InfiniteTablePropColumnGroups, InfiniteTablePropColumnOrder, InfiniteTablePropColumnPinning, InfiniteTablePropColumnSizing, InfiniteTablePropColumnTypes, InfiniteTablePropColumnVisibility, InfiniteTablePropColumns, InfiniteTablePropComponents, InfiniteTablePropFilterEditors, InfiniteTablePropGetColumnContextMenuItems, InfiniteTablePropGroupColumn, InfiniteTablePropGroupRenderStrategy, InfiniteTablePropHeaderOptions, InfiniteTablePropKeyboardNavigation, InfiniteTablePropRowClassName, InfiniteTablePropRowStyle, InfiniteTableProps, InfiniteTableRowClassNameFn, InfiniteTableRowInfo, InfiniteTableRowStyleFn, InfiniteTableState, LazyGroupDataDeepMap, LazyGroupDataItem, LazyRowInfoGroup, Menu, MenuChildrenFnParam, MenuColumn, MenuColumnRenderParam, MenuDecoration, MenuItemDefinition, MenuItemObject, MenuProps, MenuRenderable, MenuRuntimeItem, MenuRuntimeItemSelectable, MenuSeparator, NumberFilterEditor, OverlayShowParams, RowSelectionState, Scrollbars, StringFilterEditor, components, debounce, defaultFilterEditors, defaultFilterTypes, defaultFilterTypes as filterTypes, flatten, getComponentStateRoot, group, interceptMap, multisort, useComponentState, useDataSource, useEffectWithChanges, useInfiniteColumnCell, useInfiniteHeaderCell, useOverlay, useOverlayPortal };