chore: move row models and fns, clean up global faceting refactor

KevinVandy · KevinVandy · commit e63889063da6 · 2024-07-01T21:35:49.000-05:00
diff --git a/packages/table-core/src/core/getCoreRowModel.ts b/packages/table-core/src/core/getCoreRowModel.ts
@@ -1,4 +1,4 @@
-import { _createRow } from '../core/row'
+import { _createRow } from './row'
 import { Table, Row, RowModel, RowData } from '../types'
 import { getMemoOptions, memo } from '../utils'
 
diff --git a/packages/table-core/src/features/column-faceting/getFacetedRowModel.ts b/packages/table-core/src/features/column-faceting/getFacetedRowModel.ts
@@ -1,6 +1,6 @@
 import { Table, RowModel, Row, RowData } from '../../types'
 import { getMemoOptions, memo } from '../../utils'
-import { filterRows } from '../../utils/filterRowsUtils'
+import { filterRows } from '../column-filtering/filterRowsUtils'
 
 export function getFacetedRowModel<TData extends RowData>(): (
   table: Table<TData>,
diff --git a/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts b/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts
@@ -1,4 +1,4 @@
-import { BuiltInFilterFn } from '../../filterFns'
+import { BuiltInFilterFn } from '../../fns/filterFns'
 import {
   Column,
   FilterFns,
diff --git a/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts b/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts
@@ -1,4 +1,4 @@
-import { BuiltInFilterFn, filterFns } from '../../filterFns'
+import { BuiltInFilterFn, filterFns } from '../../fns/filterFns'
 import { Column, RowData, Table, Updater } from '../../types'
 import { functionalUpdate, isFunction } from '../../utils'
 import { ColumnFiltersState, FilterFn } from './ColumnFiltering.types'
diff --git a/packages/table-core/src/features/column-filtering/filterRowsUtils.ts b/packages/table-core/src/features/column-filtering/filterRowsUtils.ts
@@ -1,5 +1,5 @@
-import { _createRow } from '../core/row'
-import { Row, RowModel, Table, RowData } from '../types'
+import { _createRow } from '../../core/row'
+import { Row, RowModel, Table, RowData } from '../../types'
 
 export function filterRows<TData extends RowData>(
   rows: Row<TData>[],
diff --git a/packages/table-core/src/features/column-filtering/getFilteredRowModel.ts b/packages/table-core/src/features/column-filtering/getFilteredRowModel.ts
@@ -1,6 +1,6 @@
-import { ResolvedColumnFilter } from '../features/column-filtering/ColumnFiltering.types'
-import { Table, RowModel, Row, RowData } from '../types'
-import { getMemoOptions, memo } from '../utils'
+import { ResolvedColumnFilter } from './ColumnFiltering.types'
+import { Table, RowModel, Row, RowData } from '../../types'
+import { getMemoOptions, memo } from '../../utils'
 import { filterRows } from './filterRowsUtils'
 
 export function getFilteredRowModel<TData extends RowData>(): (
diff --git a/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts b/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts
@@ -1,4 +1,4 @@
-import { BuiltInAggregationFn } from '../../aggregationFns'
+import { BuiltInAggregationFn } from '../../fns/aggregationFns'
 import {
   AggregationFns,
   Cell,
diff --git a/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts b/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts
@@ -1,4 +1,4 @@
-import { BuiltInAggregationFn, aggregationFns } from '../../aggregationFns'
+import { BuiltInAggregationFn, aggregationFns } from '../../fns/aggregationFns'
 import { Cell, Column, Row, RowData, Table, Updater } from '../../types'
 import { isFunction } from '../../utils'
 import { GroupingState } from './ColumnGrouping.types'
diff --git a/packages/table-core/src/features/column-grouping/getGroupedRowModel.ts b/packages/table-core/src/features/column-grouping/getGroupedRowModel.ts
@@ -1,6 +1,6 @@
-import { _createRow } from '../core/row'
-import { Table, Row, RowModel, RowData } from '../types'
-import { flattenBy, getMemoOptions, memo } from '../utils'
+import { _createRow } from '../../core/row'
+import { Table, Row, RowModel, RowData } from '../../types'
+import { flattenBy, getMemoOptions, memo } from '../../utils'
 
 export function getGroupedRowModel<TData extends RowData>(): (
   table: Table<TData>
diff --git a/packages/table-core/src/features/column-ordering/ColumnOrdering.ts b/packages/table-core/src/features/column-ordering/ColumnOrdering.ts
@@ -1,8 +1,5 @@
 import { getMemoOptions, makeStateUpdater, memo } from '../../utils'
-
 import { Column, RowData, Table, TableFeature } from '../../types'
-
-import { column_getVisibleLeafColumns } from '../..'
 import {
   ColumnOrderDefaultOptions,
   ColumnOrderTableState,
@@ -15,6 +12,7 @@ import {
   table_resetColumnOrder,
   table_setColumnOrder,
 } from './ColumnOrdering.utils'
+import { column_getVisibleLeafColumns } from '../column-visibility/ColumnVisibility.utils'
 
 export const ColumnOrdering: TableFeature = {
   _getInitialState: (state): ColumnOrderTableState => {
diff --git a/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts b/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts
@@ -1,12 +1,10 @@
+import { Column, RowData, Table, Updater } from '../../types'
 import {
-  ColumnPinningPosition,
+  GroupingColumnMode,
   GroupingState,
-  Table,
-  Updater,
-  column_getVisibleLeafColumns,
-} from '../..'
-import { Column, RowData } from '../../types'
-import { GroupingColumnMode } from '../column-grouping/ColumnGrouping.types'
+} from '../column-grouping/ColumnGrouping.types'
+import { ColumnPinningPosition } from '../column-pinning/ColumnPinning.types'
+import { column_getVisibleLeafColumns } from '../column-visibility/ColumnVisibility.utils'
 import { ColumnOrderState } from './ColumnOrdering.types'
 
 export function column_getIndex<TData extends RowData>(
diff --git a/packages/table-core/src/features/global-faceting/GlobalFaceting.ts b/packages/table-core/src/features/global-faceting/GlobalFaceting.ts
@@ -7,22 +7,12 @@ import {
 
 export const GlobalFaceting: TableFeature = {
   _createTable: <TData extends RowData>(table: Table<TData>): void => {
-    table._getGlobalFacetedRowModel =
-      table.options.getFacetedRowModel &&
-      table.options.getFacetedRowModel(table, '__global__')
+    table.getGlobalFacetedMinMaxValues =
+      table_getGlobalFacetedMinMaxValues(table)
 
-    table.getGlobalFacetedRowModel = () => table_getGlobalFacetedRowModel(table)
+    table.getGlobalFacetedRowModel = table_getGlobalFacetedRowModel(table)
 
-    table._getGlobalFacetedUniqueValues =
-      table.options.getFacetedUniqueValues &&
-      table.options.getFacetedUniqueValues(table, '__global__')
-    table.getGlobalFacetedUniqueValues = () =>
+    table.getGlobalFacetedUniqueValues =
       table_getGlobalFacetedUniqueValues(table)
-
-    table._getGlobalFacetedMinMaxValues =
-      table.options.getFacetedMinMaxValues &&
-      table.options.getFacetedMinMaxValues(table, '__global__')
-    table.getGlobalFacetedMinMaxValues = () =>
-      table_getGlobalFacetedMinMaxValues(table)
   },
 }
diff --git a/packages/table-core/src/features/global-faceting/GlobalFaceting.types.ts b/packages/table-core/src/features/global-faceting/GlobalFaceting.types.ts
@@ -1,12 +1,9 @@
 import { RowData, RowModel } from '../../types'
 
 export interface GlobalFacetingInstance<TData extends RowData> {
-  _getGlobalFacetedMinMaxValues?: () => undefined | [number, number]
-  _getGlobalFacetedRowModel?: () => RowModel<TData>
-  _getGlobalFacetedUniqueValues?: () => Map<any, number>
   /**
-   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalautofilterfn)
+   * Returns the min and max values for the global filter.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedminmaxvalues)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
    */
   getGlobalFacetedMinMaxValues: () => undefined | [number, number]
diff --git a/packages/table-core/src/features/global-faceting/GlobalFaceting.utils.ts b/packages/table-core/src/features/global-faceting/GlobalFaceting.utils.ts
@@ -1,31 +1,28 @@
-import { RowData, Table } from '../../types'
+import { RowData, RowModel, Table } from '../../types'
 
-export function table_getGlobalFacetedRowModel<TData extends RowData>(
+export function table_getGlobalFacetedMinMaxValues<TData extends RowData>(
   table: Table<TData>
 ) {
-  if (table.options.manualFiltering || !table._getGlobalFacetedRowModel) {
-    return table.getPreFilteredRowModel()
-  }
-
-  return table._getGlobalFacetedRowModel()
+  return (
+    table.options.getFacetedMinMaxValues?.(table, '__global__') ??
+    (() => undefined)
+  )
 }
 
-export function table_getGlobalFacetedUniqueValues<TData extends RowData>(
+export function table_getGlobalFacetedRowModel<TData extends RowData>(
   table: Table<TData>
-) {
-  if (!table._getGlobalFacetedUniqueValues) {
-    return new Map()
-  }
-
-  return table._getGlobalFacetedUniqueValues()
+): () => RowModel<TData> {
+  return (
+    table.options.getFacetedRowModel?.(table, '__global__') ??
+    (() => table.getPreFilteredRowModel())
+  )
 }
 
-export function table_getGlobalFacetedMinMaxValues<TData extends RowData>(
+export function table_getGlobalFacetedUniqueValues<TData extends RowData>(
   table: Table<TData>
-) {
-  if (!table._getGlobalFacetedMinMaxValues) {
-    return
-  }
-
-  return table._getGlobalFacetedMinMaxValues()
+): () => Map<any, number> {
+  return (
+    table.options.getFacetedUniqueValues?.(table, '__global__') ??
+    (() => new Map())
+  )
 }
diff --git a/packages/table-core/src/features/global-filtering/GlobalFiltering.ts b/packages/table-core/src/features/global-filtering/GlobalFiltering.ts
@@ -5,15 +5,13 @@ import {
   table_getGlobalFilterFn,
   table_resetGlobalFilter,
   table_setGlobalFilter,
-} from '../..'
+} from './GlobalFiltering.utils'
 import { Column, Table, RowData, TableFeature } from '../../types'
 import {
   GlobalFilterOptions,
   GlobalFilterTableState,
 } from './GlobalFiltering.types'
 
-//
-
 export const GlobalFiltering: TableFeature = {
   _getInitialState: (state): GlobalFilterTableState => {
     return {
diff --git a/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts b/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts
@@ -1,4 +1,4 @@
-import { BuiltInFilterFn, filterFns } from '../../filterFns'
+import { BuiltInFilterFn, filterFns } from '../../fns/filterFns'
 import { Column, RowData, Table } from '../../types'
 import { isFunction, makeStateUpdater } from '../../utils'
 import { GlobalFilterOptions } from './GlobalFiltering.types'
diff --git a/packages/table-core/src/features/row-expanding/RowExpanding.ts b/packages/table-core/src/features/row-expanding/RowExpanding.ts
@@ -1,10 +1,6 @@
 import { Table, Row, RowData, TableFeature } from '../../types'
 import { makeStateUpdater } from '../../utils'
-import {
-  ExpandedOptions,
-  ExpandedStateList,
-  ExpandedTableState,
-} from './RowExpanding.types'
+import { ExpandedOptions, ExpandedTableState } from './RowExpanding.types'
 import {
   row_getCanExpand,
   row_getIsAllParentsExpanded,
diff --git a/packages/table-core/src/features/row-expanding/getExpandedRowModel.ts b/packages/table-core/src/features/row-expanding/getExpandedRowModel.ts
@@ -1,5 +1,5 @@
-import { Table, Row, RowModel, RowData } from '../types'
-import { getMemoOptions, memo } from '../utils'
+import { Table, Row, RowModel, RowData } from '../../types'
+import { getMemoOptions, memo } from '../../utils'
 
 export function getExpandedRowModel<TData extends RowData>(): (
   table: Table<TData>
diff --git a/packages/table-core/src/features/row-pagination/getPaginationRowModel.ts b/packages/table-core/src/features/row-pagination/getPaginationRowModel.ts
@@ -1,6 +1,6 @@
-import { Table, RowModel, Row, RowData } from '../types'
-import { getMemoOptions, memo } from '../utils'
-import { expandRows } from './getExpandedRowModel'
+import { Table, RowModel, Row, RowData } from '../../types'
+import { getMemoOptions, memo } from '../../utils'
+import { expandRows } from '../row-expanding/getExpandedRowModel'
 
 export function getPaginationRowModel<TData extends RowData>(opts?: {
   initialSync: boolean
diff --git a/packages/table-core/src/features/row-sorting/RowSorting.ts b/packages/table-core/src/features/row-sorting/RowSorting.ts
@@ -1,7 +1,4 @@
 import {
-  SortingColumnDef,
-  SortingOptions,
-  SortingTableState,
   column_clearSorting,
   column_getAutoSortDir,
   column_getAutoSortingFn,
@@ -18,7 +15,12 @@ import {
   table_getSortedRowModel,
   table_resetSorting,
   table_setSorting,
-} from '../..'
+} from './RowSorting.utils'
+import {
+  SortingColumnDef,
+  SortingOptions,
+  SortingTableState,
+} from './RowSorting.types'
 import { Column, Table, RowData, TableFeature } from '../../types'
 import { makeStateUpdater } from '../../utils'
 
diff --git a/packages/table-core/src/features/row-sorting/RowSorting.types.ts b/packages/table-core/src/features/row-sorting/RowSorting.types.ts
@@ -1,4 +1,4 @@
-import { BuiltInSortingFn } from '../../sortingFns'
+import { BuiltInSortingFn } from '../../fns/sortingFns'
 import {
   OnChangeFn,
   Row,
diff --git a/packages/table-core/src/features/row-sorting/RowSorting.utils.ts b/packages/table-core/src/features/row-sorting/RowSorting.utils.ts
@@ -2,7 +2,7 @@ import {
   BuiltInSortingFn,
   reSplitAlphaNumeric,
   sortingFns,
-} from '../../sortingFns'
+} from '../../fns/sortingFns'
 import { Column, RowData, Table, Updater } from '../../types'
 import { isFunction } from '../../utils'
 import { SortingState } from './RowSorting.types'
diff --git a/packages/table-core/src/features/row-sorting/getSortedRowModel.ts b/packages/table-core/src/features/row-sorting/getSortedRowModel.ts
@@ -1,6 +1,6 @@
-import { Table, Row, RowModel, RowData } from '../types'
-import { SortingFn } from '../features/row-sorting/RowSorting.types'
-import { getMemoOptions, memo } from '../utils'
+import { Table, Row, RowModel, RowData } from '../../types'
+import { SortingFn } from './RowSorting.types'
+import { getMemoOptions, memo } from '../../utils'
 
 export function getSortedRowModel<TData extends RowData>(): (
   table: Table<TData>
diff --git a/packages/table-core/src/fns/aggregationFns.ts b/packages/table-core/src/fns/aggregationFns.ts
@@ -1,5 +1,5 @@
-import { AggregationFn } from './features/column-grouping/ColumnGrouping.types'
-import { isNumberArray } from './utils'
+import { AggregationFn } from '../features/column-grouping/ColumnGrouping.types'
+import { isNumberArray } from '../utils'
 
 const sum: AggregationFn<any> = (columnId, _leafRows, childRows) => {
   // It's faster to just add the aggregations together instead of
diff --git a/packages/table-core/src/fns/filterFns.ts b/packages/table-core/src/fns/filterFns.ts
@@ -1,4 +1,4 @@
-import { FilterFn } from './features/column-filtering/ColumnFiltering.types'
+import { FilterFn } from '../features/column-filtering/ColumnFiltering.types'
 
 const includesString: FilterFn<any> = (
   row,
diff --git a/packages/table-core/src/fns/sortingFns.ts b/packages/table-core/src/fns/sortingFns.ts
@@ -1,4 +1,4 @@
-import { SortingFn } from './features/row-sorting/RowSorting.types'
+import { SortingFn } from '../features/row-sorting/RowSorting.types'
 
 export const reSplitAlphaNumeric = /([0-9]+)/gm
 
diff --git a/packages/table-core/src/index.ts b/packages/table-core/src/index.ts
@@ -9,11 +9,14 @@ export * from './types'
  * Core
  */
 
+export * from './utils'
+
 export * from './core/cell'
 export * from './core/column'
 export * from './core/headers'
 export * from './core/row'
 export * from './core/table'
+export * from './core/getCoreRowModel'
 
 /**
  * Features
@@ -31,11 +34,13 @@ export * from './features/column-faceting/getFacetedUniqueValues'
 export * from './features/column-filtering/ColumnFiltering'
 export * from './features/column-filtering/ColumnFiltering.types'
 export * from './features/column-filtering/ColumnFiltering.utils'
+export * from './features/column-filtering/getFilteredRowModel'
 
 //ColumnGrouping
 export * from './features/column-grouping/ColumnGrouping'
 export * from './features/column-grouping/ColumnGrouping.types'
 export * from './features/column-grouping/ColumnGrouping.utils'
+export * from './features/column-grouping/getGroupedRowModel'
 
 //ColumnOrdering
 export * from './features/column-ordering/ColumnOrdering'
@@ -73,11 +78,13 @@ export * from './features/global-filtering/GlobalFiltering.utils'
 export * from './features/row-expanding/RowExpanding'
 export * from './features/row-expanding/RowExpanding.types'
 export * from './features/row-expanding/RowExpanding.utils'
+export * from './features/row-expanding/getExpandedRowModel'
 
 //RowPagination
 export * from './features/row-pagination/RowPagination'
 export * from './features/row-pagination/RowPagination.types'
 export * from './features/row-pagination/RowPagination.utils'
+export * from './features/row-pagination/getPaginationRowModel'
 
 //RowPinning
 export * from './features/row-pinning/RowPinning'
@@ -93,23 +100,12 @@ export * from './features/row-selection/RowSelection.utils'
 export * from './features/row-sorting/RowSorting'
 export * from './features/row-sorting/RowSorting.types'
 export * from './features/row-sorting/RowSorting.utils'
-
-/**
- * Utils
- */
-
-export * from './utils'
-export * from './utils/getCoreRowModel'
-export * from './utils/getExpandedRowModel'
-export * from './utils/getFilteredRowModel'
-export * from './utils/getGroupedRowModel'
-export * from './utils/getPaginationRowModel'
-export * from './utils/getSortedRowModel'
+export * from './features/row-sorting/getSortedRowModel'
 
 /**
  * Fns
  */
 
-export * from './aggregationFns'
-export * from './filterFns'
-export * from './sortingFns'
+export * from './fns/aggregationFns'
+export * from './fns/filterFns'
+export * from './fns/sortingFns'
diff --git a/packages/table-core/tests/RowPinning.test.ts b/packages/table-core/tests/RowPinning.test.ts
diff --git a/packages/table-core/tests/getGroupedRowModel.test.ts b/packages/table-core/tests/getGroupedRowModel.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { _createRow } from '../core/row'`
	`1`	`+import { _createRow } from './row'`
`2`	`2`	`import { Table, Row, RowModel, RowData } from '../types'`
`3`	`3`	`import { getMemoOptions, memo } from '../utils'`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { BuiltInFilterFn } from '../../filterFns'`
	`1`	`+import { BuiltInFilterFn } from '../../fns/filterFns'`
`2`	`2`	`import {`
`3`	`3`	`Column,`
`4`	`4`	`FilterFns,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { BuiltInFilterFn, filterFns } from '../../filterFns'`
	`1`	`+import { BuiltInFilterFn, filterFns } from '../../fns/filterFns'`
`2`	`2`	`import { Column, RowData, Table, Updater } from '../../types'`
`3`	`3`	`import { functionalUpdate, isFunction } from '../../utils'`
`4`	`4`	`import { ColumnFiltersState, FilterFn } from './ColumnFiltering.types'`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { BuiltInAggregationFn } from '../../aggregationFns'`
	`1`	`+import { BuiltInAggregationFn } from '../../fns/aggregationFns'`
`2`	`2`	`import {`
`3`	`3`	`AggregationFns,`
`4`	`4`	`Cell,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { BuiltInAggregationFn, aggregationFns } from '../../aggregationFns'`
	`1`	`+import { BuiltInAggregationFn, aggregationFns } from '../../fns/aggregationFns'`
`2`	`2`	`import { Cell, Column, Row, RowData, Table, Updater } from '../../types'`
`3`	`3`	`import { isFunction } from '../../utils'`
`4`	`4`	`import { GroupingState } from './ColumnGrouping.types'`