@tanstack/table-core 9.0.0-alpha.4 → 9.0.0-alpha.41

package/src/types/TableOptions.ts

@@ -0,0 +1,125 @@
+import type { CoreFeatures } from '../core/coreFeatures'
+import type { TableOptions_Cell } from '../core/cells/coreCellsFeature.types'
+import type { TableOptions_Columns } from '../core/columns/coreColumnsFeature.types'
+import type { TableOptions_Rows } from '../core/rows/coreRowsFeature.types'
+import type { TableOptions_Table } from '../core/table/coreTablesFeature.types'
+import type { TableOptions_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
+import type { TableOptions_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { TableOptions_ColumnOrdering } from '../features/column-ordering/columnOrderingFeature.types'
+import type { TableOptions_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
+import type { TableOptions_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
+import type { TableOptions_ColumnSizing } from '../features/column-sizing/columnSizingFeature.types'
+import type { TableOptions_ColumnVisibility } from '../features/column-visibility/columnVisibilityFeature.types'
+import type { TableOptions_GlobalFiltering } from '../features/global-filtering/globalFilteringFeature.types'
+import type { TableOptions_RowExpanding } from '../features/row-expanding/rowExpandingFeature.types'
+import type { TableOptions_RowPagination } from '../features/row-pagination/rowPaginationFeature.types'
+import type { TableOptions_RowPinning } from '../features/row-pinning/rowPinningFeature.types'
+import type { TableOptions_RowSelection } from '../features/row-selection/rowSelectionFeature.types'
+import type { TableOptions_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
+import type { RowData, UnionToIntersection } from './type-utils'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+
+export interface TableOptions_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {}
+
+export interface TableOptions_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>
+  extends
+    TableOptions_Table<TFeatures, TData>,
+    TableOptions_Cell,
+    TableOptions_Columns<TFeatures, TData>,
+    TableOptions_Rows<TFeatures, TData> {}
+
+type DebugKeysFor<TFeatures extends TableFeatures> = {
+  [K in keyof TFeatures & string as `debug${Capitalize<K>}`]?: boolean
+}
+
+export type DebugOptions<TFeatures extends TableFeatures> = {
+  debugAll?: boolean
+  debugCache?: boolean
+  debugCells?: boolean
+  debugColumns?: boolean
+  debugHeaders?: boolean
+  debugRows?: boolean
+  debugTable?: boolean
+} & DebugKeysFor<CoreFeatures & TFeatures>
+
+export type TableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = TableOptions_Core<TFeatures, TData> &
+  UnionToIntersection<
+    | ('columnFilteringFeature' extends keyof TFeatures
+        ? TableOptions_ColumnFiltering<TFeatures, TData>
+        : never)
+    | ('columnGroupingFeature' extends keyof TFeatures
+        ? TableOptions_ColumnGrouping
+        : never)
+    | ('columnOrderingFeature' extends keyof TFeatures
+        ? TableOptions_ColumnOrdering
+        : never)
+    | ('columnPinningFeature' extends keyof TFeatures
+        ? TableOptions_ColumnPinning
+        : never)
+    | ('columnResizingFeature' extends keyof TFeatures
+        ? TableOptions_ColumnResizing
+        : never)
+    | ('columnSizingFeature' extends keyof TFeatures
+        ? TableOptions_ColumnSizing
+        : never)
+    | ('columnVisibilityFeature' extends keyof TFeatures
+        ? TableOptions_ColumnVisibility
+        : never)
+    | ('globalFilteringFeature' extends keyof TFeatures
+        ? TableOptions_GlobalFiltering<TFeatures, TData>
+        : never)
+    | ('rowExpandingFeature' extends keyof TFeatures
+        ? TableOptions_RowExpanding<TFeatures, TData>
+        : never)
+    | ('rowPaginationFeature' extends keyof TFeatures
+        ? TableOptions_RowPagination
+        : never)
+    | ('rowPinningFeature' extends keyof TFeatures
+        ? TableOptions_RowPinning<TFeatures, TData>
+        : never)
+    | ('rowSelectionFeature' extends keyof TFeatures
+        ? TableOptions_RowSelection<TFeatures, TData>
+        : never)
+    | ('rowSortingFeature' extends keyof TFeatures
+        ? TableOptions_RowSorting
+        : never)
+  > &
+  ExtractFeatureTypes<'TableOptions', TFeatures> &
+  TableOptions_Plugins<TFeatures, TData> &
+  DebugOptions<TFeatures>
+
+// export type TableOptions<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+// > = TableOptions_Core<TFeatures, TData> &
+//   ExtractFeatureTypes<'TableOptions', TFeatures> &
+//   TableOptions_Plugins<TFeatures, TData>
+
+export type TableOptions_All<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = TableOptions_Core<TFeatures, TData> &
+  Partial<
+    TableOptions_ColumnFiltering<TFeatures, TData> &
+      TableOptions_ColumnGrouping &
+      TableOptions_ColumnOrdering &
+      TableOptions_ColumnPinning &
+      TableOptions_ColumnResizing &
+      TableOptions_ColumnSizing &
+      TableOptions_ColumnVisibility &
+      TableOptions_GlobalFiltering<TFeatures, TData> &
+      TableOptions_RowExpanding<TFeatures, TData> &
+      TableOptions_RowPagination &
+      TableOptions_RowPinning<TFeatures, TData> &
+      TableOptions_RowSelection<TFeatures, TData> &
+      TableOptions_RowSorting
+  >

package/src/types/TableState.ts

@@ -0,0 +1,88 @@
+import type { UnionToIntersection } from './type-utils'
+import type { TableState_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
+import type { TableState_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { TableState_ColumnOrdering } from '../features/column-ordering/columnOrderingFeature.types'
+import type { TableState_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
+import type { TableState_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
+import type { TableState_ColumnSizing } from '../features/column-sizing/columnSizingFeature.types'
+import type { TableState_ColumnVisibility } from '../features/column-visibility/columnVisibilityFeature.types'
+import type { TableState_GlobalFiltering } from '../features/global-filtering/globalFilteringFeature.types'
+import type { TableState_RowExpanding } from '../features/row-expanding/rowExpandingFeature.types'
+import type { TableState_RowPagination } from '../features/row-pagination/rowPaginationFeature.types'
+import type { TableState_RowPinning } from '../features/row-pinning/rowPinningFeature.types'
+import type { TableState_RowSelection } from '../features/row-selection/rowSelectionFeature.types'
+import type { TableState_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+
+/**
+ * Use this interface as a target for declaration merging to add your own state properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface TableState_Plugins<TFeatures extends TableFeatures> {}
+
+export type TableState<TFeatures extends TableFeatures> = UnionToIntersection<
+  | ('columnFilteringFeature' extends keyof TFeatures
+      ? TableState_ColumnFiltering
+      : never)
+  | ('columnGroupingFeature' extends keyof TFeatures
+      ? TableState_ColumnGrouping
+      : never)
+  | ('columnOrderingFeature' extends keyof TFeatures
+      ? TableState_ColumnOrdering
+      : never)
+  | ('columnPinningFeature' extends keyof TFeatures
+      ? TableState_ColumnPinning
+      : never)
+  | ('columnResizingFeature' extends keyof TFeatures
+      ? TableState_ColumnResizing
+      : never)
+  | ('columnSizingFeature' extends keyof TFeatures
+      ? TableState_ColumnSizing
+      : never)
+  | ('columnVisibilityFeature' extends keyof TFeatures
+      ? TableState_ColumnVisibility
+      : never)
+  | ('globalFilteringFeature' extends keyof TFeatures
+      ? TableState_GlobalFiltering
+      : never)
+  | ('rowExpandingFeature' extends keyof TFeatures
+      ? TableState_RowExpanding
+      : never)
+  | ('rowPaginationFeature' extends keyof TFeatures
+      ? TableState_RowPagination
+      : never)
+  | ('rowPinningFeature' extends keyof TFeatures
+      ? TableState_RowPinning
+      : never)
+  | ('rowSelectionFeature' extends keyof TFeatures
+      ? TableState_RowSelection
+      : never)
+  | ('rowSortingFeature' extends keyof TFeatures
+      ? TableState_RowSorting
+      : never)
+> &
+  ExtractFeatureTypes<'TableState', TFeatures> &
+  TableState_Plugins<TFeatures>
+
+// export type TableState<TFeatures extends TableFeatures> = ExtractFeatureTypes<
+// export type TableState<TFeatures extends TableFeatures> = ExtractFeatureTypes<
+//   'TableState',
+//   TFeatures
+// > &
+//   TableState_Plugins<TFeatures>
+
+export type TableState_All = Partial<
+  TableState_ColumnFiltering &
+    TableState_ColumnGrouping &
+    TableState_ColumnOrdering &
+    TableState_ColumnPinning &
+    TableState_ColumnResizing &
+    TableState_ColumnSizing &
+    TableState_ColumnVisibility &
+    TableState_GlobalFiltering &
+    TableState_RowExpanding &
+    TableState_RowPagination &
+    TableState_RowPinning &
+    TableState_RowSelection &
+    TableState_RowSorting
+>

package/src/types/type-utils.ts

@@ -0,0 +1,84 @@
+export type Updater<T> = T | ((old: T) => T)
+
+export type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void
+
+export type RowData = Record<string, any> | Array<any>
+
+export type CellData = unknown
+
+export type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+
+export type RequiredKeys<T, K extends keyof T> = Omit<T, K> &
+  Required<Pick<T, K>>
+
+export type UnionToIntersection<T> = (
+  T extends any ? (x: T) => any : never
+) extends (x: infer R) => any
+  ? R
+  : never
+
+type ComputeRange<
+  N extends number,
+  Result extends Array<unknown> = [],
+> = Result['length'] extends N
+  ? Result
+  : ComputeRange<N, [...Result, Result['length']]>
+
+type Index40 = ComputeRange<40>[number]
+
+// Is this type a tuple?
+type IsTuple<T> = T extends ReadonlyArray<any> & { length: infer Length }
+  ? Length extends Index40
+    ? T
+    : never
+  : never
+
+// If this type is a tuple, what indices are allowed?
+type AllowedIndexes<
+  Tuple extends ReadonlyArray<any>,
+  Keys extends number = never,
+> = Tuple extends readonly []
+  ? Keys
+  : Tuple extends readonly [infer _, ...infer Tail]
+    ? AllowedIndexes<Tail, Keys | Tail['length']>
+    : Keys
+
+export type DeepKeys<
+  T,
+  TDepth extends Array<any> = [],
+> = TDepth['length'] extends 5
+  ? never
+  : unknown extends T
+    ? string
+    : T extends ReadonlyArray<any> & IsTuple<T>
+      ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>, TDepth>
+      : T extends Array<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,
+  TPrefix,
+  TDepth extends Array<any>,
+> = TPrefix extends keyof T & (number | string)
+  ? `${TPrefix}.${DeepKeys<T[TPrefix], [...TDepth, any]> & string}`
+  : never
+
+export type DeepValue<T, TProp> =
+  T extends Record<string | number, any>
+    ? TProp extends `${infer TBranch}.${infer TDeepProp}`
+      ? DeepValue<T[TBranch], TDeepProp>
+      : T[TProp & string]
+    : never
+
+export type NoInfer<T> = [T][T extends any ? 0 : never]
+
+export type Getter<TValue> = <TTValue = TValue>() => NoInfer<TTValue>
+
+export type Prettify<T> = {
+  [K in keyof T]: T[K]
+} & unknown