@tanstack/table-core 9.0.0-beta.1 → 9.0.0-beta.11

package/src/features/column-visibility/columnVisibilityFeature.types.ts

@@ -28,8 +28,8 @@ export type VisibilityDefaultOptions = Pick<
 >
 
 export interface Table_ColumnVisibility<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Checks whether every leaf column is currently visible.
@@ -76,8 +76,8 @@ export interface ColumnDef_ColumnVisibility {
 }
 
 export interface Row_ColumnVisibility<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Gets this row's cells for currently visible columns.

package/src/features/global-filtering/globalFilteringFeature.ts

@@ -10,90 +10,56 @@ import {
   table_resetGlobalFilter,
   table_setGlobalFilter,
 } from './globalFilteringFeature.utils'
-import type { RowData } from '../../types/type-utils'
-import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
-// import type {
-//   ColumnDef_GlobalFiltering,
-//   Column_GlobalFiltering,
-//   TableOptions_GlobalFiltering,
-//   TableState_GlobalFiltering,
-//   Table_GlobalFiltering,
-// } from './globalFilteringFeature.types'
-
-export interface GlobalFilteringFeatureConstructors<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  // Column: Column_GlobalFiltering
-  // ColumnDef: ColumnDef_GlobalFiltering
-  // Table: Table_GlobalFiltering<TFeatures, TData>
-  // TableOptions: TableOptions_GlobalFiltering<TFeatures, TData>
-  // TableState: TableState_GlobalFiltering
-}
+import type { TableFeature } from '../../types/TableFeatures'
 
 /**
- * Creates the stock global filtering feature.
- *
- * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ * Feature that adds global filtering state, defaults, and global filter APIs.
  */
-export function constructGlobalFilteringFeature<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>> {
-  return {
-    getInitialState: (initialState) => {
-      return {
-        globalFilter: undefined,
-        ...initialState,
-      }
-    },
+export const globalFilteringFeature: TableFeature = {
+  getInitialState: (initialState) => {
+    return {
+      globalFilter: undefined,
+      ...initialState,
+    }
+  },
 
-    getDefaultTableOptions: (table) => {
-      return {
-        onGlobalFilterChange: makeStateUpdater('globalFilter', table),
-        globalFilterFn: 'auto',
-        getColumnCanGlobalFilter: (column) => {
-          const value = table
-            .getCoreRowModel()
-            .flatRows[0]?.getAllCellsByColumnId()
-            [column.id]?.getValue()
+  getDefaultTableOptions: (table) => {
+    return {
+      onGlobalFilterChange: makeStateUpdater('globalFilter', table),
+      globalFilterFn: 'auto',
+      getColumnCanGlobalFilter: (column) => {
+        const value = table
+          .getCoreRowModel()
+          .flatRows[0]?.getAllCellsByColumnId()
+          [column.id]?.getValue()
 
-          return typeof value === 'string' || typeof value === 'number'
-        },
-      }
-    },
+        return typeof value === 'string' || typeof value === 'number'
+      },
+    }
+  },
 
-    assignColumnPrototype: (prototype, table) => {
-      assignPrototypeAPIs('globalFilteringFeature', prototype, table, {
-        column_getCanGlobalFilter: {
-          fn: (column) => column_getCanGlobalFilter(column),
-        },
-      })
-    },
+  assignColumnPrototype: (prototype, table) => {
+    assignPrototypeAPIs('globalFilteringFeature', prototype, table, {
+      column_getCanGlobalFilter: {
+        fn: (column) => column_getCanGlobalFilter(column),
+      },
+    })
+  },
 
-    constructTableAPIs: (table) => {
-      assignTableAPIs('globalFilteringFeature', table, {
-        table_getGlobalAutoFilterFn: {
-          fn: () => table_getGlobalAutoFilterFn(),
-        },
-        table_getGlobalFilterFn: {
-          fn: () => table_getGlobalFilterFn(table),
-        },
-        table_setGlobalFilter: {
-          fn: (updater) => table_setGlobalFilter(table, updater),
-        },
-        table_resetGlobalFilter: {
-          fn: (defaultState) => table_resetGlobalFilter(table, defaultState),
-        },
-      })
-    },
-  }
+  constructTableAPIs: (table) => {
+    assignTableAPIs('globalFilteringFeature', table, {
+      table_getGlobalAutoFilterFn: {
+        fn: () => table_getGlobalAutoFilterFn(),
+      },
+      table_getGlobalFilterFn: {
+        fn: () => table_getGlobalFilterFn(table),
+      },
+      table_setGlobalFilter: {
+        fn: (updater) => table_setGlobalFilter(table, updater),
+      },
+      table_resetGlobalFilter: {
+        fn: (defaultState) => table_resetGlobalFilter(table, defaultState),
+      },
+    })
+  },
 }
-
-/**
- * The stock global filtering feature.
- *
- * Register this feature with column filtering support to add global filter
- * state, global filter function resolution, and column eligibility APIs.
- */
-export const globalFilteringFeature = constructGlobalFilteringFeature()

package/src/features/global-filtering/globalFilteringFeature.types.ts

@@ -33,8 +33,8 @@ export interface Column_GlobalFiltering {
 }
 
 export interface TableOptions_GlobalFiltering<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Enables global filtering across columns that allow it.
@@ -67,8 +67,8 @@ export interface TableOptions_GlobalFiltering<
 }
 
 export interface Table_GlobalFiltering<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * 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.

package/src/features/global-filtering/globalFilteringFeature.utils.ts

@@ -63,16 +63,18 @@ export function table_getGlobalFilterFn<
   TData extends RowData,
 >(
   table: Table_Internal<TFeatures, TData>,
-): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined {
+): FilterFn<TFeatures, TData> | undefined {
   const { globalFilterFn: globalFilterFn } = table.options
   const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =
     table._rowModelFns.filterFns
 
-  return isFunction(globalFilterFn)
+  const filterFn = isFunction(globalFilterFn)
     ? globalFilterFn
     : globalFilterFn === 'auto'
       ? table_getGlobalAutoFilterFn()
       : filterFns?.[globalFilterFn as string]
+
+  return filterFn
 }
 
 /**

package/src/features/row-expanding/createExpandedRowModel.ts

@@ -16,7 +16,7 @@ export function createExpandedRowModel<
   TData extends RowData = any,
 >(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {
   return (_table) => {
-    const table: Table_Internal<TFeatures, TData> = _table
+    const table = _table as unknown as Table_Internal<TFeatures, TData>
     return tableMemo({
       feature: 'rowExpandingFeature',
       table,

package/src/features/row-expanding/rowExpandingFeature.ts

@@ -20,111 +20,75 @@ import {
   table_setExpanded,
   table_toggleAllRowsExpanded,
 } from './rowExpandingFeature.utils'
-import type { RowData } from '../../types/type-utils'
-import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
-// import type {
-//   CachedRowModel_Expanded,
-//   CreateRowModel_Expanded,
-//   Row_RowExpanding,
-//   TableOptions_RowExpanding,
-//   TableState_RowExpanding,
-//   Table_RowExpanding,
-// } from './rowExpandingFeature.types'
-
-export interface RowExpandingFeatureConstructors<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  // CachedRowModel: CachedRowModel_Expanded<TFeatures, TData>
-  // CreateRowModels: CreateRowModel_Expanded<TFeatures, TData>
-  // Row: Row_RowExpanding
-  // Table: Table_RowExpanding<TFeatures, TData>
-  // TableOptions: TableOptions_RowExpanding<TFeatures, TData>
-  // TableState: TableState_RowExpanding
-}
+import type { TableFeature } from '../../types/TableFeatures'
 
 /**
- * Creates the stock row expanding feature.
- *
- * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ * Feature that adds row expansion state and APIs for expandable row trees.
  */
-export function constructRowExpandingFeature<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(): TableFeature<RowExpandingFeatureConstructors<TFeatures, TData>> {
-  return {
-    getInitialState: (initialState) => {
-      return {
-        expanded: getDefaultExpandedState(),
-        ...initialState,
-      }
-    },
+export const rowExpandingFeature: TableFeature = {
+  getInitialState: (initialState) => {
+    return {
+      expanded: getDefaultExpandedState(),
+      ...initialState,
+    }
+  },
 
-    getDefaultTableOptions: (table) => {
-      return {
-        onExpandedChange: makeStateUpdater('expanded', table),
-        paginateExpandedRows: true,
-      }
-    },
+  getDefaultTableOptions: (table) => {
+    return {
+      onExpandedChange: makeStateUpdater('expanded', table),
+      paginateExpandedRows: true,
+    }
+  },
 
-    assignRowPrototype: (prototype, table) => {
-      assignPrototypeAPIs('rowExpandingFeature', prototype, table, {
-        row_toggleExpanded: {
-          fn: (row, expanded) => row_toggleExpanded(row, expanded),
-        },
-        row_getIsExpanded: {
-          fn: (row) => row_getIsExpanded(row),
-        },
-        row_getCanExpand: {
-          fn: (row) => row_getCanExpand(row),
-        },
-        row_getIsAllParentsExpanded: {
-          fn: (row) => row_getIsAllParentsExpanded(row),
-        },
-        row_getToggleExpandedHandler: {
-          fn: (row) => row_getToggleExpandedHandler(row),
-        },
-      })
-    },
+  assignRowPrototype: (prototype, table) => {
+    assignPrototypeAPIs('rowExpandingFeature', prototype, table, {
+      row_toggleExpanded: {
+        fn: (row, expanded) => row_toggleExpanded(row, expanded),
+      },
+      row_getIsExpanded: {
+        fn: (row) => row_getIsExpanded(row),
+      },
+      row_getCanExpand: {
+        fn: (row) => row_getCanExpand(row),
+      },
+      row_getIsAllParentsExpanded: {
+        fn: (row) => row_getIsAllParentsExpanded(row),
+      },
+      row_getToggleExpandedHandler: {
+        fn: (row) => row_getToggleExpandedHandler(row),
+      },
+    })
+  },
 
-    constructTableAPIs: (table) => {
-      assignTableAPIs('rowExpandingFeature', table, {
-        table_autoResetExpanded: {
-          fn: () => table_autoResetExpanded(table),
-        },
-        table_setExpanded: {
-          fn: (updater) => table_setExpanded(table, updater),
-        },
-        table_toggleAllRowsExpanded: {
-          fn: (expanded) => table_toggleAllRowsExpanded(table, expanded),
-        },
-        table_resetExpanded: {
-          fn: (defaultState) => table_resetExpanded(table, defaultState),
-        },
-        table_getCanSomeRowsExpand: {
-          fn: () => table_getCanSomeRowsExpand(table),
-        },
-        table_getToggleAllRowsExpandedHandler: {
-          fn: () => table_getToggleAllRowsExpandedHandler(table),
-        },
-        table_getIsSomeRowsExpanded: {
-          fn: () => table_getIsSomeRowsExpanded(table),
-        },
-        table_getIsAllRowsExpanded: {
-          fn: () => table_getIsAllRowsExpanded(table),
-        },
-        table_getExpandedDepth: {
-          fn: () => table_getExpandedDepth(table),
-        },
-      })
-    },
-  }
+  constructTableAPIs: (table) => {
+    assignTableAPIs('rowExpandingFeature', table, {
+      table_autoResetExpanded: {
+        fn: () => table_autoResetExpanded(table),
+      },
+      table_setExpanded: {
+        fn: (updater) => table_setExpanded(table, updater),
+      },
+      table_toggleAllRowsExpanded: {
+        fn: (expanded) => table_toggleAllRowsExpanded(table, expanded),
+      },
+      table_resetExpanded: {
+        fn: (defaultState) => table_resetExpanded(table, defaultState),
+      },
+      table_getCanSomeRowsExpand: {
+        fn: () => table_getCanSomeRowsExpand(table),
+      },
+      table_getToggleAllRowsExpandedHandler: {
+        fn: () => table_getToggleAllRowsExpandedHandler(table),
+      },
+      table_getIsSomeRowsExpanded: {
+        fn: () => table_getIsSomeRowsExpanded(table),
+      },
+      table_getIsAllRowsExpanded: {
+        fn: () => table_getIsAllRowsExpanded(table),
+      },
+      table_getExpandedDepth: {
+        fn: () => table_getExpandedDepth(table),
+      },
+    })
+  },
 }
-
-/**
- * The stock row expanding feature.
- *
- * Register this feature to add expanded row state, row expansion APIs, and
- * helpers for deriving expanded row models and expansion depth.
- */
-export const rowExpandingFeature = constructRowExpandingFeature()

package/src/features/row-expanding/rowExpandingFeature.types.ts

@@ -35,8 +35,8 @@ export interface Row_RowExpanding {
 }
 
 export interface TableOptions_RowExpanding<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Enables automatic expanded-state resets when page-altering table state changes.
@@ -71,8 +71,8 @@ export interface TableOptions_RowExpanding<
 }
 
 export interface Table_RowExpanding<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   autoResetExpanded: () => void
   /**
@@ -112,8 +112,8 @@ export interface Table_RowExpanding<
 }
 
 export interface Table_RowModels_Expanded<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Resolves the row model after expanded rows have been flattened into view.
@@ -125,23 +125,9 @@ export interface Table_RowModels_Expanded<
   getPreExpandedRowModel: () => RowModel<TFeatures, TData>
 }
 
-export interface CreateRowModel_Expanded<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Factory used to retrieve the expanded row model. If this function is not
-   * provided, the table will not expand rows. To use client-side expansion,
-   * pass `createExpandedRowModel()` or implement your own factory.
-   */
-  expandedRowModel?: (
-    table: Table<TFeatures, TData>,
-  ) => () => RowModel<TFeatures, TData>
-}
-
 export interface CachedRowModel_Expanded<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   expandedRowModel: () => RowModel<TFeatures, TData>
 }

package/src/features/row-pagination/createPaginatedRowModel.ts

@@ -17,7 +17,7 @@ export function createPaginatedRowModel<
   TData extends RowData = any,
 >(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {
   return (_table) => {
-    const table: Table_Internal<TFeatures, TData> = _table
+    const table = _table as unknown as Table_Internal<TFeatures, TData>
     return tableMemo({
       feature: 'rowPaginationFeature',
       table,

package/src/features/row-pagination/rowPaginationFeature.ts

@@ -18,112 +18,78 @@ import {
   table_setPageSize,
   table_setPagination,
 } from './rowPaginationFeature.utils'
-import type { RowData } from '../../types/type-utils'
-import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
-// import type {
-//   CachedRowModel_Paginated,
-//   CreateRowModel_Paginated,
-//   TableOptions_RowPagination,
-//   TableState_RowPagination,
-//   Table_RowPagination,
-// } from './rowPaginationFeature.types'
-
-export interface RowPaginationFeatureConstructors<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  // CachedRowModel: CachedRowModel_Paginated<TFeatures, TData>
-  // CreateRowModels: CreateRowModel_Paginated<TFeatures, TData>
-  // Table: Table_RowPagination<TFeatures, TData>
-  // TableOptions: TableOptions_RowPagination<TFeatures, TData>
-  // TableState: TableState_RowPagination
-}
+import type { TableFeature } from '../../types/TableFeatures'
 
 /**
- * Creates the stock row pagination feature.
- *
- * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ * Feature that adds pagination state and table APIs for page navigation.
  */
-export function constructRowPaginationFeature<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(): TableFeature<RowPaginationFeatureConstructors<TFeatures, TData>> {
-  return {
-    getInitialState: (initialState) => {
-      return {
-        ...initialState,
-        pagination: {
-          ...getDefaultPaginationState(),
-          ...initialState.pagination,
-        },
-      }
-    },
+export const rowPaginationFeature: TableFeature = {
+  getInitialState: (initialState) => {
+    return {
+      ...initialState,
+      pagination: {
+        ...getDefaultPaginationState(),
+        ...initialState.pagination,
+      },
+    }
+  },
 
-    getDefaultTableOptions: (table) => {
-      return {
-        onPaginationChange: makeStateUpdater('pagination', table),
-      }
-    },
+  getDefaultTableOptions: (table) => {
+    return {
+      onPaginationChange: makeStateUpdater('pagination', table),
+    }
+  },
 
-    constructTableAPIs: (table) => {
-      assignTableAPIs('rowPaginationFeature', table, {
-        table_autoResetPageIndex: {
-          fn: () => table_autoResetPageIndex(table),
-        },
-        table_setPagination: {
-          fn: (updater) => table_setPagination(table, updater),
-        },
-        table_resetPagination: {
-          fn: (defaultState) => table_resetPagination(table, defaultState),
-        },
-        table_setPageIndex: {
-          fn: (updater) => table_setPageIndex(table, updater),
-        },
-        table_resetPageIndex: {
-          fn: (defaultState) => table_resetPageIndex(table, defaultState),
-        },
-        table_setPageSize: {
-          fn: (updater) => table_setPageSize(table, updater),
-        },
-        table_getPageCount: {
-          fn: () => table_getPageCount(table),
-        },
-        table_resetPageSize: {
-          fn: (defaultState) => table_resetPageSize(table, defaultState),
-        },
-        table_getPageOptions: {
-          fn: () => table_getPageOptions(table),
-        },
-        table_getCanPreviousPage: {
-          fn: () => table_getCanPreviousPage(table),
-        },
-        table_getCanNextPage: {
-          fn: () => table_getCanNextPage(table),
-        },
-        table_previousPage: {
-          fn: () => table_previousPage(table),
-        },
-        table_nextPage: {
-          fn: () => table_nextPage(table),
-        },
-        table_firstPage: {
-          fn: () => table_firstPage(table),
-        },
-        table_lastPage: {
-          fn: () => table_lastPage(table),
-        },
-        table_getRowCount: {
-          fn: () => table_getRowCount(table),
-        },
-      })
-    },
-  }
+  constructTableAPIs: (table) => {
+    assignTableAPIs('rowPaginationFeature', table, {
+      table_autoResetPageIndex: {
+        fn: () => table_autoResetPageIndex(table),
+      },
+      table_setPagination: {
+        fn: (updater) => table_setPagination(table, updater),
+      },
+      table_resetPagination: {
+        fn: (defaultState) => table_resetPagination(table, defaultState),
+      },
+      table_setPageIndex: {
+        fn: (updater) => table_setPageIndex(table, updater),
+      },
+      table_resetPageIndex: {
+        fn: (defaultState) => table_resetPageIndex(table, defaultState),
+      },
+      table_setPageSize: {
+        fn: (updater) => table_setPageSize(table, updater),
+      },
+      table_getPageCount: {
+        fn: () => table_getPageCount(table),
+      },
+      table_resetPageSize: {
+        fn: (defaultState) => table_resetPageSize(table, defaultState),
+      },
+      table_getPageOptions: {
+        fn: () => table_getPageOptions(table),
+      },
+      table_getCanPreviousPage: {
+        fn: () => table_getCanPreviousPage(table),
+      },
+      table_getCanNextPage: {
+        fn: () => table_getCanNextPage(table),
+      },
+      table_previousPage: {
+        fn: () => table_previousPage(table),
+      },
+      table_nextPage: {
+        fn: () => table_nextPage(table),
+      },
+      table_firstPage: {
+        fn: () => table_firstPage(table),
+      },
+      table_lastPage: {
+        fn: () => table_lastPage(table),
+      },
+      table_getRowCount: {
+        fn: () => table_getRowCount(table),
+      },
+    })
+  },
 }
-
-/**
- * The stock row pagination feature.
- *
- * Register this feature to add pagination state, page navigation APIs, and
- * pagination-aware row model helpers to a table.
- */
-export const rowPaginationFeature = constructRowPaginationFeature()