@tanstack/table-core 9.0.0-beta.52 → 9.0.0-beta.53

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

@@ -1,137 +0,0 @@
-import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
-import type { OnChangeFn, RowData, Updater } from '../../types/type-utils'
-import type { TableFeatures } from '../../types/TableFeatures'
-
-export interface PaginationState {
-  pageIndex: number
-  pageSize: number
-}
-
-export interface TableState_RowPagination {
-  pagination: PaginationState
-}
-
-export interface TableOptions_RowPagination {
-  /**
-   * If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc.
-   */
-  autoResetPageIndex?: boolean
-  /**
-   * Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginatedRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
-   */
-  manualPagination?: boolean
-  /**
-   * Called with an updater when pagination state changes. Pair this with
-   * `state.pagination` when using external state; external atoms can own the
-   * slice without this callback.
-   */
-  onPaginationChange?: OnChangeFn<PaginationState>
-  /**
-   * When manually controlling pagination, you can supply a total `pageCount` value to the table if you know it (Or supply a `rowCount` and `pageCount` will be calculated). If you do not know how many pages there are, you can set this to `-1`.
-   */
-  pageCount?: number
-  /**
-   * When manually controlling pagination, you can supply a total `rowCount` value to the table if you know it. The `pageCount` can be calculated from this value and the `pageSize`.
-   */
-  rowCount?: number
-}
-
-export interface PaginationDefaultOptions {
-  onPaginationChange: OnChangeFn<PaginationState>
-}
-
-export interface Table_RowPagination<
-  in out _TFeatures extends TableFeatures,
-  in out _TData extends RowData,
-> {
-  _autoResetPageIndex: () => void
-  /**
-   * Checks whether the current page index can move forward.
-   */
-  getCanNextPage: () => boolean
-  /**
-   * Checks whether the current page index can move backward.
-   */
-  getCanPreviousPage: () => boolean
-  /**
-   * Resolves the current page count from `options.pageCount` or row count and
-   * page size.
-   */
-  getPageCount: () => number
-  /**
-   * Resolves the row count used for pagination math.
-   *
-   * `options.rowCount` wins; otherwise the pre-paginated row model is counted.
-   */
-  getRowCount: () => number
-  /**
-   * Builds zero-based page indexes for the current page count.
-   */
-  getPageOptions: () => Array<number>
-  /**
-   * Increments the page index by one, if possible.
-   */
-  nextPage: () => void
-  /**
-   * Decrements the page index by one, if possible.
-   */
-  previousPage: () => void
-  /**
-   * Sets the page index to `0`.
-   */
-  firstPage: () => void
-  /**
-   * Sets the page index to the last page.
-   */
-  lastPage: () => void
-  /**
-   * Resets `pagination.pageIndex` to initial state, or to `0` when
-   * `defaultState` is `true`.
-   */
-  resetPageIndex: (defaultState?: boolean) => void
-  /**
-   * Resets `pagination.pageSize` to initial state, or to `10` when
-   * `defaultState` is `true`.
-   */
-  resetPageSize: (defaultState?: boolean) => void
-  /**
-   * Resets `pagination` to `initialState.pagination`.
-   *
-   * Pass `true` to ignore initial state and reset to
-   * `{ pageIndex: 0, pageSize: 10 }`.
-   */
-  resetPagination: (defaultState?: boolean) => void
-  /**
-   * Updates `pagination.pageIndex` using a value or updater.
-   */
-  setPageIndex: (updater: Updater<number>) => void
-  /**
-   * Updates `pagination.pageSize` using a value or updater.
-   */
-  setPageSize: (updater: Updater<number>) => void
-  /**
-   * Updates pagination state with a next state or updater function.
-   */
-  setPagination: (updater: Updater<PaginationState>) => void
-}
-
-export interface Table_RowModels_Paginated<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
-> {
-  /**
-   * Resolves the row model after pagination has sliced the current page.
-   */
-  getPaginatedRowModel: () => RowModel<TFeatures, TData>
-  /**
-   * Reads the row model immediately before pagination.
-   */
-  getPrePaginatedRowModel: () => RowModel<TFeatures, TData>
-}
-
-export interface CachedRowModel_Paginated<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
-> {
-  paginatedRowModel: () => RowModel<TFeatures, TData>
-}

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

@@ -1,400 +0,0 @@
-import { cloneState, functionalUpdate } from '../../utils'
-import type { RowData, Updater } from '../../types/type-utils'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { Table_Internal } from '../../types/Table'
-import type { PaginationState } from './rowPaginationFeature.types'
-
-const defaultPageIndex = 0
-const defaultPageSize = 10
-
-/**
- * Creates the default pagination state used by the pagination feature.
- *
- * The feature default starts at the first page with a page size of 10. Reset
- * APIs use this value when `defaultState` is `true`.
- *
- * @example
- * ```ts
- * const pagination = getDefaultPaginationState()
- * ```
- */
-export function getDefaultPaginationState(): PaginationState {
-  return {
-    pageIndex: defaultPageIndex,
-    pageSize: defaultPageSize,
-  }
-}
-
-/**
- * Resets the page index when a page-altering change should return to page 0.
- *
- * The reset runs when `autoResetAll`, `autoResetPageIndex`, or the default
- * client-side pagination behavior allows it. Manual pagination opts out unless
- * the reset options explicitly opt back in.
- *
- * @example
- * ```ts
- * table_autoResetPageIndex(table)
- * ```
- */
-export function table_autoResetPageIndex<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  if (
-    table.options.autoResetAll ??
-    table.options.autoResetPageIndex ??
-    !table.options.manualPagination
-  ) {
-    table_resetPageIndex(table, true)
-  }
-}
-
-/**
- * Routes a pagination updater through the table's pagination change handler.
- *
- * The updater may be a next state object or a function of the previous
- * `PaginationState`; controlled state and external atoms observe the same
- * updater path as the instance API.
- *
- * @example
- * ```ts
- * table_setPagination(table, (old) => old)
- * ```
- */
-export function table_setPagination<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>, updater: Updater<PaginationState>) {
-  const safeUpdater: Updater<PaginationState> = (old) => {
-    const newState = functionalUpdate(updater, old)
-
-    return newState
-  }
-
-  return table.options.onPaginationChange?.(safeUpdater)
-}
-
-/**
- * Resets `pagination` to the configured initial state or feature default.
- *
- * With no argument, the reset clones `table.initialState.pagination` when it
- * exists. Passing `true` ignores initial state and resets to
- * `{ pageIndex: 0, pageSize: 10 }`.
- *
- * @example
- * ```ts
- * table_resetPagination(table)
- * table_resetPagination(table, true)
- * ```
- */
-export function table_resetPagination<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {
-  table_setPagination(
-    table,
-    defaultState
-      ? getDefaultPaginationState()
-      : cloneState(
-          table.initialState.pagination ?? getDefaultPaginationState(),
-        ),
-  )
-}
-
-/**
- * Updates `pagination.pageIndex` and clamps it to the known page range.
- *
- * Unknown page counts (`undefined` or `-1`) allow any non-negative page index.
- * Known page counts clamp the index between `0` and `pageCount - 1`.
- *
- * @example
- * ```ts
- * table_setPageIndex(table, (old) => old)
- * ```
- */
-export function table_setPageIndex<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>, updater: Updater<number>) {
-  table_setPagination(table, (old) => {
-    let pageIndex = functionalUpdate(updater, old.pageIndex)
-
-    const maxPageIndex =
-      typeof table.options.pageCount === 'undefined' ||
-      table.options.pageCount === -1
-        ? Number.MAX_SAFE_INTEGER
-        : table.options.pageCount - 1
-
-    pageIndex = Math.max(0, Math.min(pageIndex, maxPageIndex))
-
-    return {
-      ...old,
-      pageIndex,
-    }
-  })
-}
-
-/**
- * Resets only `pagination.pageIndex`.
- *
- * With no argument, the reset uses `table.initialState.pagination?.pageIndex`
- * or `0`. Passing `true` always resets the page index to `0`.
- *
- * @example
- * ```ts
- * table_resetPageIndex(table)
- * table_resetPageIndex(table, true)
- * ```
- */
-export function table_resetPageIndex<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {
-  const currentPageIndex =
-    table.atoms.pagination?.get()?.pageIndex ?? defaultPageIndex
-  const newPageIndex = defaultState
-    ? defaultPageIndex
-    : (table.initialState.pagination?.pageIndex ?? defaultPageIndex)
-  if (newPageIndex === currentPageIndex) return
-  table_setPageIndex(table, newPageIndex)
-}
-
-/**
- * Resets only `pagination.pageSize`.
- *
- * With no argument, the reset uses `table.initialState.pagination?.pageSize`
- * or `10`. Passing `true` always resets the page size to `10`.
- *
- * @example
- * ```ts
- * table_resetPageSize(table)
- * table_resetPageSize(table, true)
- * ```
- */
-export function table_resetPageSize<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {
-  const currentPageSize =
-    table.atoms.pagination?.get()?.pageSize ?? defaultPageSize
-  const newPageSize = defaultState
-    ? defaultPageSize
-    : (table.initialState.pagination?.pageSize ?? defaultPageSize)
-  if (newPageSize === currentPageSize) return
-  table_setPageSize(table, newPageSize)
-}
-
-/**
- * Updates `pagination.pageSize` while preserving the current top row.
- *
- * The new size is clamped to at least `1`, and `pageIndex` is recalculated so
- * the row that was previously at the top of the page remains in view.
- *
- * @example
- * ```ts
- * table_setPageSize(table, (old) => old)
- * ```
- */
-export function table_setPageSize<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>, updater: Updater<number>) {
-  table_setPagination(table, (old) => {
-    const pageSize = Math.max(1, functionalUpdate(updater, old.pageSize))
-    const topRowIndex = old.pageSize * old.pageIndex
-    const pageIndex = Math.floor(topRowIndex / pageSize)
-
-    return {
-      ...old,
-      pageIndex,
-      pageSize,
-    }
-  })
-}
-
-/**
- * Builds the zero-based page indexes available for the current page count.
- *
- * Unknown or empty page counts return an empty array; otherwise the result is
- * `[0, 1, ...pageCount - 1]`.
- *
- * @example
- * ```ts
- * const pageIndexes = table_getPageOptions(table)
- * ```
- */
-export function table_getPageOptions<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  const pageCount = table_getPageCount(table)
-  let pageOptions: Array<number> = []
-  if (pageCount && pageCount > 0) {
-    pageOptions = [...new Array(pageCount)].fill(null).map((_, i) => i)
-  }
-  return pageOptions
-}
-
-/**
- * Checks whether the current page index can move backward.
- *
- * The first page is page index `0`, so only positive page indexes can navigate
- * to a previous page.
- *
- * @example
- * ```ts
- * const canGoBack = table_getCanPreviousPage(table)
- * ```
- */
-export function table_getCanPreviousPage<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return (table.atoms.pagination?.get()?.pageIndex ?? 0) > 0
-}
-
-/**
- * Checks whether the current page index can move forward.
- *
- * A `pageCount` of `-1` means the caller does not know the total page count, so
- * this returns `true`. A page count of `0` returns `false`.
- *
- * @example
- * ```ts
- * const canGoForward = table_getCanNextPage(table)
- * ```
- */
-export function table_getCanNextPage<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  const pageIndex = table.atoms.pagination?.get()?.pageIndex ?? defaultPageIndex
-
-  const pageCount = table_getPageCount(table)
-
-  if (pageCount === -1) {
-    return true
-  }
-
-  if (pageCount === 0) {
-    return false
-  }
-
-  return pageIndex < pageCount - 1
-}
-
-/**
- * Moves the table to the previous page.
- *
- * This delegates to `table_setPageIndex` so pagination state ownership and
- * updater semantics remain consistent.
- *
- * @example
- * ```ts
- * table_previousPage(table)
- * ```
- */
-export function table_previousPage<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return table_setPageIndex(table, (old) => old - 1)
-}
-
-/**
- * Moves the table to the next page.
- *
- * This delegates to `table_setPageIndex` so pagination state ownership and
- * updater semantics remain consistent.
- *
- * @example
- * ```ts
- * table_nextPage(table)
- * ```
- */
-export function table_nextPage<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return table_setPageIndex(table, (old) => {
-    return old + 1
-  })
-}
-
-/**
- * Moves the table to the first page.
- *
- * This is a convenience wrapper around `table_setPageIndex(table, 0)`.
- *
- * @example
- * ```ts
- * table_firstPage(table)
- * ```
- */
-export function table_firstPage<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return table_setPageIndex(table, 0)
-}
-
-/**
- * Moves the table to the last known page.
- *
- * The target page is derived from `table_getPageCount(table) - 1`.
- *
- * @example
- * ```ts
- * table_lastPage(table)
- * ```
- */
-export function table_lastPage<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return table_setPageIndex(table, table_getPageCount(table) - 1)
-}
-
-/**
- * Resolves the number of pages for the current pagination state.
- *
- * `options.pageCount` wins for manual pagination. Otherwise the value is
- * calculated from `table_getRowCount(table)` and the current `pageSize`.
- *
- * @example
- * ```ts
- * const pages = table_getPageCount(table)
- * ```
- */
-export function table_getPageCount<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return (
-    table.options.pageCount ??
-    Math.ceil(
-      table_getRowCount(table) /
-        (table.atoms.pagination?.get()?.pageSize ?? defaultPageSize),
-    )
-  )
-}
-
-/**
- * Resolves the total row count used for pagination math.
- *
- * `options.rowCount` wins for manual pagination. Otherwise the count comes
- * from the pre-paginated row model so filtering, grouping, sorting, and
- * expansion are reflected before the page slice is applied.
- *
- * @example
- * ```ts
- * const rows = table_getRowCount(table)
- * ```
- */
-export function table_getRowCount<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>) {
-  return table.options.rowCount ?? table.getPrePaginatedRowModel().rows.length
-}

package/src/features/row-pinning/rowPinningFeature.ts

@@ -1,97 +0,0 @@
-import {
-  assignPrototypeAPIs,
-  assignTableAPIs,
-  makeStateUpdater,
-} from '../../utils'
-import {
-  getDefaultRowPinningState,
-  row_getCanPin,
-  row_getIsPinned,
-  row_getPinnedIndex,
-  row_pin,
-  table_getBottomRows,
-  table_getCenterRows,
-  table_getIsSomeRowsPinned,
-  table_getTopRows,
-  table_resetRowPinning,
-  table_setRowPinning,
-} from './rowPinningFeature.utils'
-import type { TableFeature } from '../../types/TableFeatures'
-
-/**
- * Feature that adds row pinning state and APIs for top, center, and bottom rows.
- */
-export const rowPinningFeature: TableFeature = {
-  getInitialState: (initialState) => {
-    return {
-      ...initialState,
-      rowPinning: {
-        ...getDefaultRowPinningState(),
-        ...initialState.rowPinning,
-      },
-    }
-  },
-
-  getDefaultTableOptions: (table) => {
-    return {
-      onRowPinningChange: makeStateUpdater('rowPinning', table),
-    }
-  },
-
-  assignRowPrototype: (prototype, table) => {
-    assignPrototypeAPIs('rowPinningFeature', prototype, table, {
-      row_getCanPin: {
-        fn: (row) => row_getCanPin(row),
-      },
-      row_getIsPinned: {
-        fn: (row) => row_getIsPinned(row),
-      },
-      row_getPinnedIndex: {
-        fn: (row) => row_getPinnedIndex(row),
-        memoDeps: (row) => [
-          row.table.getRowModel().rows,
-          row.table.atoms.rowPinning?.get(),
-        ],
-      },
-      row_pin: {
-        fn: (row, position, includeLeafRows, includeParentRows) =>
-          row_pin(row, position, includeLeafRows, includeParentRows),
-      },
-    })
-  },
-
-  constructTableAPIs: (table) => {
-    assignTableAPIs('rowPinningFeature', table, {
-      table_setRowPinning: {
-        fn: (updater) => table_setRowPinning(table, updater),
-      },
-      table_resetRowPinning: {
-        fn: (defaultState) => table_resetRowPinning(table, defaultState),
-      },
-      table_getIsSomeRowsPinned: {
-        fn: (position) => table_getIsSomeRowsPinned(table, position),
-      },
-      table_getTopRows: {
-        fn: () => table_getTopRows(table),
-        memoDeps: () => [
-          table.getRowModel().rows,
-          table.atoms.rowPinning?.get()?.top,
-        ],
-      },
-      table_getBottomRows: {
-        fn: () => table_getBottomRows(table),
-        memoDeps: () => [
-          table.getRowModel().rows,
-          table.atoms.rowPinning?.get()?.bottom,
-        ],
-      },
-      table_getCenterRows: {
-        fn: () => table_getCenterRows(table),
-        memoDeps: () => [
-          table.getRowModel().rows,
-          table.atoms.rowPinning?.get(),
-        ],
-      },
-    })
-  },
-}