@tanstack/table-core 8.11.1 → 8.11.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.11.1",
+  "version": "8.11.3",
   "description": "Headless UI for building powerful tables & datagrids for TS/JS.",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/table#readme",
@@ -24,6 +24,7 @@
     "type": "github",
     "url": "https://github.com/sponsors/tannerlinsley"
   },
+  "type": "commonjs",
   "module": "build/lib/index.esm.js",
   "main": "build/lib/index.js",
   "types": "build/lib/index.d.ts",
@@ -43,5 +44,14 @@
     "build/lib/*",
     "build/umd/*",
     "src"
-  ]
-}
+  ],
+  "scripts": {
+    "clean": "rimraf ./build",
+    "test:lib": "vitest",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc --noEmit",
+    "build": "pnpm build:rollup && pnpm build:types",
+    "build:rollup": "rollup --config rollup.config.mjs",
+    "build:types": "tsc --emitDeclarationOnly"
+  }
+}

package/src/columnHelper.ts

@@ -6,7 +6,7 @@ import {
   IdentifiedColumnDef,
   RowData,
 } from './types'
-import { DeepKeys, DeepValue, RequiredKeys } from './utils'
+import { DeepKeys, DeepValue } from './utils'
 
 // type Person = {
 //   firstName: string
@@ -55,8 +55,8 @@ export type ColumnHelper<TData extends RowData> = {
     TValue extends TAccessor extends AccessorFn<TData, infer TReturn>
       ? TReturn
       : TAccessor extends DeepKeys<TData>
-      ? DeepValue<TData, TAccessor>
-      : never,
+        ? DeepValue<TData, TAccessor>
+        : never,
   >(
     accessor: TAccessor,
     column: TAccessor extends AccessorFn<TData>

package/src/core/row.ts

@@ -154,7 +154,8 @@ export const createRow = <TData extends RowData>(
       row.getValue(columnId) ?? table.options.renderFallbackValue,
     subRows: subRows ?? [],
     getLeafRows: () => flattenBy(row.subRows, d => d.subRows),
-    getParentRow: () => (row.parentId ? table.getRow(row.parentId, true) : undefined),
+    getParentRow: () =>
+      row.parentId ? table.getRow(row.parentId, true) : undefined,
     getParentRows: () => {
       let parentRows: Row<TData>[] = []
       let currentRow = row

package/src/core/table.ts

@@ -374,15 +374,20 @@ export function createTable<TData extends RowData>(
     getRowModel: () => {
       return table.getPaginationRowModel()
     },
+    //in next version, we should just pass in the row model as the optional 2nd arg
     getRow: (id: string, searchAll?: boolean) => {
-      const row = (searchAll ? table.getCoreRowModel() : table.getRowModel())
-        .rowsById[id]
+      let row = (
+        searchAll ? table.getPrePaginationRowModel() : table.getRowModel()
+      ).rowsById[id]
 
       if (!row) {
-        if (process.env.NODE_ENV !== 'production') {
-          throw new Error(`getRow expected an ID, but got ${id}`)
+        row = table.getCoreRowModel().rowsById[id]
+        if (!row) {
+          if (process.env.NODE_ENV !== 'production') {
+            throw new Error(`getRow could not find row with ID: ${id}`)
+          }
+          throw new Error()
         }
-        throw new Error()
       }
 
       return row

package/src/features/ColumnSizing.ts

@@ -40,7 +40,7 @@ export interface ColumnSizingOptions {
   enableColumnResizing?: boolean
   /**
    * Enables or disables right-to-left support for resizing the column. defaults to 'ltr'.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#rtl)
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#columnResizeDirection)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
    */
   columnResizeDirection?: ColumnResizeDirection
@@ -60,7 +60,10 @@ export interface ColumnSizingOptions {
 
 export type ColumnSizingDefaultOptions = Pick<
   ColumnSizingOptions,
-  'columnResizeMode' | 'onColumnSizingChange' | 'onColumnSizingInfoChange' | 'columnResizeDirection'
+  | 'columnResizeMode'
+  | 'onColumnSizingChange'
+  | 'onColumnSizingInfoChange'
+  | 'columnResizeDirection'
 >
 
 export interface ColumnSizingInstance {
@@ -258,8 +261,8 @@ export const ColumnSizing: TableFeature = {
       const columns = !position
         ? table.getVisibleLeafColumns()
         : position === 'left'
-        ? table.getLeftVisibleLeafColumns()
-        : table.getRightVisibleLeafColumns()
+          ? table.getLeftVisibleLeafColumns()
+          : table.getRightVisibleLeafColumns()
 
       const index = columns.findIndex(d => d.id === column.id)
 
@@ -355,8 +358,10 @@ export const ColumnSizing: TableFeature = {
           }
 
           table.setColumnSizingInfo(old => {
-            const deltaDirection = table.options.columnResizeDirection === 'rtl' ? -1 : 1
-            const deltaOffset = (clientXPos - (old?.startOffset ?? 0)) * deltaDirection
+            const deltaDirection =
+              table.options.columnResizeDirection === 'rtl' ? -1 : 1
+            const deltaOffset =
+              (clientXPos - (old?.startOffset ?? 0)) * deltaDirection
             const deltaPercentage = Math.max(
               deltaOffset / (old?.startSize ?? 0),
               -0.999999

package/src/features/Filters.ts

@@ -234,7 +234,7 @@ interface FiltersOptionsBase<TData extends RowData> {
   enableGlobalFilter?: boolean
   /**
    * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
-   * 
+   *
    * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcolumncanglobalfilter)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
@@ -434,10 +434,10 @@ export const Filters: TableFeature = {
       return isFunction(column.columnDef.filterFn)
         ? column.columnDef.filterFn
         : column.columnDef.filterFn === 'auto'
-        ? column.getAutoFilterFn()
-        : // @ts-ignore
-          table.options.filterFns?.[column.columnDef.filterFn as string] ??
-          filterFns[column.columnDef.filterFn as BuiltInFilterFn]
+          ? column.getAutoFilterFn()
+          : // @ts-ignore
+            table.options.filterFns?.[column.columnDef.filterFn as string] ??
+            filterFns[column.columnDef.filterFn as BuiltInFilterFn]
     }
     column.getCanFilter = () => {
       return (
@@ -556,10 +556,10 @@ export const Filters: TableFeature = {
       return isFunction(globalFilterFn)
         ? globalFilterFn
         : globalFilterFn === 'auto'
-        ? table.getGlobalAutoFilterFn()
-        : // @ts-ignore
-          table.options.filterFns?.[globalFilterFn as string] ??
-          filterFns[globalFilterFn as BuiltInFilterFn]
+          ? table.getGlobalAutoFilterFn()
+          : // @ts-ignore
+            table.options.filterFns?.[globalFilterFn as string] ??
+            filterFns[globalFilterFn as BuiltInFilterFn]
     }
 
     table.setColumnFilters = (updater: Updater<ColumnFiltersState>) => {

package/src/features/Grouping.ts

@@ -326,11 +326,13 @@ export const Grouping: TableFeature = {
       return isFunction(column.columnDef.aggregationFn)
         ? column.columnDef.aggregationFn
         : column.columnDef.aggregationFn === 'auto'
-        ? column.getAutoAggregationFn()
-        : table.options.aggregationFns?.[
-            column.columnDef.aggregationFn as string
-          ] ??
-          aggregationFns[column.columnDef.aggregationFn as BuiltInAggregationFn]
+          ? column.getAutoAggregationFn()
+          : table.options.aggregationFns?.[
+              column.columnDef.aggregationFn as string
+            ] ??
+            aggregationFns[
+              column.columnDef.aggregationFn as BuiltInAggregationFn
+            ]
     }
   },
 

package/src/features/RowSelection.ts

@@ -556,7 +556,7 @@ const mutateRowIsSelected = <TData extends RowData>(
   includeChildren: boolean,
   table: Table<TData>
 ) => {
-  const row = table.getRow(id)
+  const row = table.getRow(id, true)
 
   // const isGrouped = row.getIsGrouped()
 

package/src/features/Sorting.ts

@@ -348,9 +348,9 @@ export const Sorting: TableFeature = {
       return isFunction(column.columnDef.sortingFn)
         ? column.columnDef.sortingFn
         : column.columnDef.sortingFn === 'auto'
-        ? column.getAutoSortingFn()
-        : table.options.sortingFns?.[column.columnDef.sortingFn as string] ??
-          sortingFns[column.columnDef.sortingFn as BuiltInSortingFn]
+          ? column.getAutoSortingFn()
+          : table.options.sortingFns?.[column.columnDef.sortingFn as string] ??
+            sortingFns[column.columnDef.sortingFn as BuiltInSortingFn]
     }
     column.toggleSorting = (desc, multi) => {
       // if (column.columns.length) {

package/src/types.ts

@@ -265,8 +265,10 @@ export type AccessorFnColumnDef<
   TValue = unknown,
 > = AccessorFnColumnDefBase<TData, TValue> & ColumnIdentifiers<TData, TValue>
 
-export interface AccessorKeyColumnDefBase<TData extends RowData, TValue = unknown>
-  extends ColumnDefBase<TData, TValue> {
+export interface AccessorKeyColumnDefBase<
+  TData extends RowData,
+  TValue = unknown,
+> extends ColumnDefBase<TData, TValue> {
   id?: string
   accessorKey: (string & {}) | keyof TData
 }

package/src/utils/getSortedRowModel.ts

@@ -18,8 +18,8 @@ export function getSortedRowModel<TData extends RowData>(): (
         const sortedFlatRows: Row<TData>[] = []
 
         // Filter out sortings that correspond to non existing columns
-        const availableSorting = sortingState.filter(sort =>
-          table.getColumn(sort.id)?.getCanSort()
+        const availableSorting = sortingState.filter(
+          sort => table.getColumn(sort.id)?.getCanSort()
         )
 
         const columnInfoById: Record<
@@ -45,7 +45,7 @@ export function getSortedRowModel<TData extends RowData>(): (
         const sortData = (rows: Row<TData>[]) => {
           // This will also perform a stable sorting using the row index
           // if needed.
-          const sortedData = rows.map(row => ({...row}))
+          const sortedData = rows.map(row => ({ ...row }))
 
           sortedData.sort((rowA, rowB) => {
             for (let i = 0; i < availableSorting.length; i += 1) {
@@ -68,8 +68,8 @@ export function getSortedRowModel<TData extends RowData>(): (
                     aUndefined && bUndefined
                       ? 0
                       : aUndefined
-                      ? columnInfo.sortUndefined
-                      : -columnInfo.sortUndefined
+                        ? columnInfo.sortUndefined
+                        : -columnInfo.sortUndefined
                 }
               }
 

package/src/utils.ts

@@ -40,24 +40,24 @@ type AllowedIndexes<
 > = Tuple extends readonly []
   ? Keys
   : Tuple extends readonly [infer _, ...infer Tail]
-  ? AllowedIndexes<Tail, Keys | Tail['length']>
-  : Keys
+    ? AllowedIndexes<Tail, Keys | Tail['length']>
+    : Keys
 
 export type DeepKeys<T, TDepth extends any[] = []> = TDepth['length'] extends 5
   ? never
   : unknown extends T
-  ? string
-  : object extends T
-  ? string
-  : T extends readonly any[] & IsTuple<T>
-  ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>, TDepth>
-  : T extends any[]
-  ? DeepKeys<T[number], [...TDepth, any]>
-  : T extends Date
-  ? never
-  : T extends object
-  ? (keyof T & string) | DeepKeysPrefix<T, keyof T, TDepth>
-  : never
+    ? string
+    : object extends T
+      ? string
+      : T extends readonly any[] & IsTuple<T>
+        ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>, TDepth>
+        : T extends any[]
+          ? DeepKeys<T[number], [...TDepth, any]>
+          : T extends Date
+            ? never
+            : T extends object
+              ? (keyof T & string) | DeepKeysPrefix<T, keyof T, TDepth>
+              : never
 
 type DeepKeysPrefix<
   T,