@tanstack/table-core 9.0.0-beta.2 → 9.0.0-beta.20

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-expanding/rowExpandingFeature.utils.ts

@@ -1,4 +1,4 @@
-import { cloneState } from '../../utils'
+import { cloneState, hasOwn, makeObjectMap } from '../../utils'
 import type { RowData, Updater } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
 import type { Table_Internal } from '../../types/Table'
@@ -20,7 +20,7 @@ import type {
  * ```
  */
 export function getDefaultExpandedState(): ExpandedState {
-  return {}
+  return makeObjectMap()
 }
 
 /**
@@ -85,7 +85,7 @@ export function table_toggleAllRowsExpanded<
   if (expanded ?? !table_getIsAllRowsExpanded(table)) {
     table_setExpanded(table, true)
   } else {
-    table_setExpanded(table, {})
+    table_setExpanded(table, makeObjectMap())
   }
 }
 
@@ -105,9 +105,17 @@ export function table_resetExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {
+  const initialExpanded = table.initialState.expanded
   table_setExpanded(
     table,
-    defaultState ? {} : cloneState(table.initialState.expanded ?? {}),
+    defaultState
+      ? makeObjectMap()
+      : initialExpanded === true
+        ? true
+        : Object.assign(
+            makeObjectMap<boolean | undefined>(),
+            cloneState(initialExpanded ?? {}),
+          ),
   )
 }
 
@@ -252,29 +260,34 @@ export function row_toggleExpanded<
   TData extends RowData,
 >(row: Row<TFeatures, TData>, expanded?: boolean) {
   table_setExpanded(row.table, (old) => {
-    const exists = old === true ? true : !!old[row.id]
+    const exists = old === true ? true : isExpandedRowId(old, row.id)
 
-    let oldExpanded: ExpandedStateList = {}
+    let oldExpanded: ExpandedStateList = makeObjectMap()
 
     if (old === true) {
       Object.keys(row.table.getRowModel().rowsById).forEach((rowId) => {
         oldExpanded[rowId] = true
       })
     } else {
-      oldExpanded = old
+      oldExpanded = Object.assign(makeObjectMap<boolean | undefined>(), old)
     }
 
     expanded = expanded ?? !exists
 
     if (!exists && expanded) {
-      return {
-        ...oldExpanded,
-        [row.id]: true,
-      }
+      oldExpanded[row.id] = true
+      return oldExpanded
     }
 
     if (exists && !expanded) {
-      const { [row.id]: _, ...rest } = oldExpanded
+      const rest: ExpandedStateList = makeObjectMap()
+      const rowIds = Object.keys(oldExpanded)
+      for (let i = 0; i < rowIds.length; i++) {
+        const rowId = rowIds[i]!
+        if (rowId !== row.id && oldExpanded[rowId]) {
+          rest[rowId] = true
+        }
+      }
       return rest
     }
 
@@ -301,7 +314,19 @@ export function row_getIsExpanded<
 
   return !!(
     row.table.options.getIsRowExpanded?.(row) ??
-    (expanded === true || expanded[row.id])
+    (expanded === true || isExpandedRowId(expanded, row.id))
+  )
+}
+
+function isExpandedRowId(
+  expanded: ExpandedState | undefined,
+  rowId: string,
+): boolean {
+  return !!(
+    expanded &&
+    expanded !== true &&
+    hasOwn(expanded, rowId) &&
+    expanded[rowId]
   )
 }
 

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,
@@ -25,7 +25,7 @@ export function createPaginatedRowModel<
       memoDeps: () => [
         table.getPrePaginatedRowModel(),
         table.atoms.pagination?.get(),
-        table.options.paginateExpandedRows
+        !table.options.paginateExpandedRows
           ? table.atoms.expanded?.get()
           : undefined,
       ],

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()

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

@@ -42,8 +42,8 @@ export interface PaginationDefaultOptions {
 }
 
 export interface Table_RowPagination<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   _autoResetPageIndex: () => void
   /**
@@ -117,8 +117,8 @@ export interface Table_RowPagination<
 }
 
 export interface Table_RowModels_Paginated<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Resolves the row model after pagination has sliced the current page.
@@ -130,23 +130,9 @@ export interface Table_RowModels_Paginated<
   getPrePaginatedRowModel: () => RowModel<TFeatures, TData>
 }
 
-export interface CreateRowModel_Paginated<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Factory used to retrieve the paginated row model. If using server-side
-   * pagination, this is not required. To use client-side pagination, pass
-   * `createPaginatedRowModel()` or implement your own factory.
-   */
-  paginatedRowModel?: (
-    table: Table<TFeatures, TData>,
-  ) => () => RowModel<TFeatures, TData>
-}
-
 export interface CachedRowModel_Paginated<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   paginatedRowModel: () => RowModel<TFeatures, TData>
 }