fix getdefaultoptions type errors

Author: KevinVandy

docs/guide/custom-features.md

@@ -43,7 +43,7 @@ export interface TableFeature<TFeatures extends TableFeatures, TFns extends Fns<
   constructRow?: (row: Row<TFeatures, TFns, TData>, table: Table<TFeatures, TFns, TData>) => void
   constructTable?: (table: Table<TFeatures, TFns, TData>) => void
   getDefaultColumnDef?: () => Partial<ColumnDef<TFeatures, TFns, TData, unknown>>
-  getDefaultOptions?: (
+  getDefaultTableOptions?: (
     table: Table<TFeatures, TFns, TData>
   ) => Partial<TableOptions<TFeatures, TFns, TData>>
   getInitialState?: (initialState?: InitialTableState) => Partial<TableState>
@@ -56,9 +56,9 @@ This might be a bit confusing, so let's break down what each of these methods do
 
 <br />
 
-##### getDefaultOptions
+##### getDefaultTableOptions
 
-The `getDefaultOptions` method in a table feature is responsible for setting the default table options for that feature. For example, in the [Column Sizing](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/ColumnSizing.ts) feature, the `getDefaultOptions` method sets the default `columnResizeMode` option with a default value of `"onEnd"`.
+The `getDefaultTableOptions` method in a table feature is responsible for setting the default table options for that feature. For example, in the [Column Sizing](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/ColumnSizing.ts) feature, the `getDefaultTableOptions` method sets the default `columnResizeMode` option with a default value of `"onEnd"`.
 
 <br />
 
@@ -187,7 +187,7 @@ export const DensityFeature: TableFeature<any> = { //Use the TableFeature type!!
   },
 
   // define the new feature's default options
-  getDefaultOptions: <TFeatures extends TableFeatures, TFns extends Fns<TFeatures, TFns, TData>, TData extends RowData>(
+  getDefaultTableOptions: <TFeatures extends TableFeatures, TFns extends Fns<TFeatures, TFns, TData>, TData extends RowData>(
     table: Partial<Table<TFeatures, TFns, TData>>
   ): DensityOptions => {
     return {

examples/react/custom-features/src/main.tsx

@@ -89,7 +89,7 @@ export const DensityFeature: TableFeature = {
   },
 
   // define the new feature's default options
-  getDefaultOptions: <
+  getDefaultTableOptions: <
     TFeatures extends TableFeatures,
     TFns extends Fns<TFeatures, TFns, TData>,
     TData extends RowData,

packages/table-core/src/core/table/constructTable.ts

@@ -35,7 +35,7 @@ export function constructTable<
   const table = {} as unknown as Table<TFeatures, TFns, TData>
 
   const defaultOptions = featuresList.reduce((obj, feature) => {
-    return Object.assign(obj, feature.getDefaultOptions?.(table))
+    return Object.assign(obj, feature.getDefaultTableOptions?.(table))
   }, {}) as TableOptions<TFeatures, TFns, TData>
 
   const initialState = getInitialTableState(_features, options.initialState)

packages/table-core/src/features/column-filtering/ColumnFiltering.ts

@@ -7,6 +7,7 @@ import {
   column_getFilterValue,
   column_getIsFiltered,
   column_setFilterValue,
+  getDefaultColumnFiltersState,
   table_getFilteredRowModel,
   table_getPreFilteredRowModel,
   table_resetColumnFilters,
@@ -41,7 +42,7 @@ export const ColumnFiltering: TableFeature = {
     state: TableState<TFeatures>,
   ): TableState<TFeatures> & TableState_ColumnFiltering => {
     return {
-      columnFilters: [],
+      columnFilters: getDefaultColumnFiltersState(),
       ...state,
     }
   },
@@ -56,7 +57,7 @@ export const ColumnFiltering: TableFeature = {
     }
   },
 
-  getDefaultOptions: <
+  getDefaultTableOptions: <
     TFeatures extends TableFeatures,
     TFns extends Fns<TFeatures, TFns, TData>,
     TData extends RowData,

packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts

@@ -16,6 +16,10 @@ import type {
   FilterFn,
 } from './ColumnFiltering.types'
 
+export function getDefaultColumnFiltersState(): ColumnFiltersState {
+  return structuredClone([])
+}
+
 export function column_getAutoFilterFn<
   TFeatures extends TableFeatures,
   TFns extends Fns<TFeatures, TFns, TData>,

packages/table-core/src/features/column-grouping/ColumnGrouping.ts

@@ -10,6 +10,7 @@ import {
   column_getIsGrouped,
   column_getToggleGroupingHandler,
   column_toggleGrouping,
+  getDefaultGroupingState,
   row_getGroupingValue,
   row_getIsGrouped,
   table_getGroupedRowModel,
@@ -45,7 +46,7 @@ export const ColumnGrouping: TableFeature = {
     state: TableState<TFeatures>,
   ): TableState<TFeatures> & TableState_ColumnGrouping => {
     return {
-      grouping: [],
+      grouping: getDefaultGroupingState(),
       ...state,
     }
   },
@@ -62,7 +63,7 @@ export const ColumnGrouping: TableFeature = {
     }
   },
 
-  getDefaultOptions: <
+  getDefaultTableOptions: <
     TFeatures extends TableFeatures,
     TFns extends Fns<TFeatures, TFns, TData>,
     TData extends RowData,

packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts

@@ -20,6 +20,10 @@ import type {
   Row_ColumnGrouping,
 } from './ColumnGrouping.types'
 
+export function getDefaultGroupingState(): GroupingState {
+  return structuredClone([])
+}
+
 export function column_toggleGrouping<
   TFeatures extends TableFeatures,
   TFns extends Fns<TFeatures, TFns, TData>,

packages/table-core/src/features/column-ordering/ColumnOrdering.ts

@@ -4,6 +4,7 @@ import {
   column_getIndex,
   column_getIsFirstColumn,
   column_getIsLastColumn,
+  getDefaultColumnOrderState,
   table_resetColumnOrder,
   table_setColumnOrder,
 } from './ColumnOrdering.utils'
@@ -30,12 +31,12 @@ export const ColumnOrdering: TableFeature = {
     state: TableState<TFeatures>,
   ): TableState<TFeatures> & TableState_ColumnOrdering => {
     return {
-      columnOrder: [],
+      columnOrder: getDefaultColumnOrderState(),
       ...state,
     }
   },
 
-  getDefaultOptions: <
+  getDefaultTableOptions: <
     TFeatures extends TableFeatures,
     TFns extends Fns<TFeatures, TFns, TData>,
     TData extends RowData,

packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts

@@ -11,6 +11,10 @@ import type { Column } from '../../types/Column'
 import type { ColumnPinningPosition } from '../column-pinning/ColumnPinning.types'
 import type { ColumnOrderState } from './ColumnOrdering.types'
 
+export function getDefaultColumnOrderState(): ColumnOrderState {
+  return structuredClone([])
+}
+
 export function column_getIndex<
   TFeatures extends TableFeatures,
   TFns extends Fns<TFeatures, TFns, TData>,
@@ -103,7 +107,7 @@ export function table_getOrderColumnsFn<
         const targetColumnId = columnOrderCopy.shift()
         const foundIndex = columnsCopy.findIndex((d) => d.id === targetColumnId)
         if (foundIndex > -1) {
-          orderedColumns.push(columnsCopy.splice(foundIndex, 1)[0])
+          orderedColumns.push(columnsCopy.splice(foundIndex, 1)[0]!)
         }
       }
 

packages/table-core/src/features/column-pinning/ColumnPinning.ts

@@ -64,7 +64,7 @@ export const ColumnPinning: TableFeature = {
     }
   },
 
-  getDefaultOptions: <
+  getDefaultTableOptions: <
     TFeatures extends TableFeatures,
     TFns extends Fns<TFeatures, TFns, TData>,
     TData extends RowData,