@tanstack/table-core 9.0.0-beta.9 → 9.0.0

package/dist/features/column-ordering/columnOrderingFeature.js

@@ -1,5 +1,5 @@
 import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../utils.js";
-import { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder } from "./columnOrderingFeature.utils.js";
+import { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, table_getColumnIndexes, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder } from "./columnOrderingFeature.utils.js";
 
 //#region src/features/column-ordering/columnOrderingFeature.ts
 /**
@@ -17,42 +17,37 @@ const columnOrderingFeature = {
 	},
 	assignColumnPrototype: (prototype, table) => {
 		assignPrototypeAPIs("columnOrderingFeature", prototype, table, {
-			column_getIndex: {
-				fn: (column, position) => column_getIndex(column, position),
-				memoDeps: (column, position) => {
-					var _column$table$atoms$c, _column$table$atoms$c2, _column$table$atoms$g, _column$table$atoms$c3;
-					return [
-						position,
-						(_column$table$atoms$c = column.table.atoms.columnOrder) === null || _column$table$atoms$c === void 0 ? void 0 : _column$table$atoms$c.get(),
-						(_column$table$atoms$c2 = column.table.atoms.columnPinning) === null || _column$table$atoms$c2 === void 0 ? void 0 : _column$table$atoms$c2.get(),
-						(_column$table$atoms$g = column.table.atoms.grouping) === null || _column$table$atoms$g === void 0 ? void 0 : _column$table$atoms$g.get(),
-						(_column$table$atoms$c3 = column.table.atoms.columnVisibility) === null || _column$table$atoms$c3 === void 0 ? void 0 : _column$table$atoms$c3.get()
-					];
-				}
-			},
+			column_getIndex: { fn: (column, position) => column_getIndex(column, position) },
 			column_getIsFirstColumn: { fn: (column, position) => column_getIsFirstColumn(column, position) },
 			column_getIsLastColumn: { fn: (column, position) => column_getIsLastColumn(column, position) }
 		});
 	},
 	constructTableAPIs: (table) => {
 		assignTableAPIs("columnOrderingFeature", table, {
+			table_getColumnIndexes: {
+				fn: () => table_getColumnIndexes(table),
+				memoDeps: () => [
+					table.options.columns,
+					table.atoms.columnOrder?.get(),
+					table.atoms.columnPinning?.get(),
+					table.atoms.columnVisibility?.get(),
+					table.atoms.grouping?.get(),
+					table.options.groupedColumnMode
+				]
+			},
 			table_setColumnOrder: { fn: (updater) => table_setColumnOrder(table, updater) },
 			table_resetColumnOrder: { fn: (defaultState) => table_resetColumnOrder(table, defaultState) },
 			table_getOrderColumnsFn: {
 				fn: () => table_getOrderColumnsFn(table),
-				memoDeps: () => {
-					var _table$atoms$columnOr, _table$atoms$grouping;
-					return [
-						(_table$atoms$columnOr = table.atoms.columnOrder) === null || _table$atoms$columnOr === void 0 ? void 0 : _table$atoms$columnOr.get(),
-						(_table$atoms$grouping = table.atoms.grouping) === null || _table$atoms$grouping === void 0 ? void 0 : _table$atoms$grouping.get(),
-						table.options.groupedColumnMode
-					];
-				}
+				memoDeps: () => [
+					table.atoms.columnOrder?.get(),
+					table.atoms.grouping?.get(),
+					table.options.groupedColumnMode
+				]
 			}
 		});
 	}
 };
 
 //#endregion
-export { columnOrderingFeature };
-//# sourceMappingURL=columnOrderingFeature.js.map
+export { columnOrderingFeature };

package/dist/features/column-ordering/columnOrderingFeature.types.d.ts

@@ -1,9 +1,26 @@
 import { OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
 import { ColumnPinningPosition } from "../column-pinning/columnPinningFeature.types.js";
 import { TableFeatures } from "../../types/TableFeatures.js";
-
 //#region src/features/column-ordering/columnOrderingFeature.types.d.ts
 type ColumnOrderState = Array<string>;
+interface ColumnIndexes {
+  /**
+   * Maps each visible leaf column id to its index in the full visible column list.
+   */
+  all: Record<string, number>;
+  /**
+   * Maps each unpinned visible leaf column id to its index within the center region.
+   */
+  center: Record<string, number>;
+  /**
+   * Maps each start-pinned visible leaf column id to its index within the start region.
+   */
+  start: Record<string, number>;
+  /**
+   * Maps each end-pinned visible leaf column id to its index within the end region.
+   */
+  end: Record<string, number>;
+}
 interface TableState_ColumnOrdering {
   columnOrder: ColumnOrderState;
 }
@@ -19,7 +36,7 @@ interface Column_ColumnOrdering {
   /**
    * Finds this column's zero-based index among visible columns.
    *
-   * Pass `'left'`, `'center'`, or `'right'` to measure within that pinned
+   * Pass `'start'`, `'center'`, or `'end'` to measure within that pinned
    * region instead of the full visible leaf order.
    */
   getIndex: (position?: ColumnPinningPosition | 'center') => number;
@@ -39,7 +56,14 @@ interface Column_ColumnOrdering {
 interface ColumnOrderDefaultOptions {
   onColumnOrderChange: OnChangeFn<ColumnOrderState>;
 }
-interface Table_ColumnOrdering<TFeatures extends TableFeatures, TData extends RowData> {
+interface Table_ColumnOrdering<in out _TFeatures extends TableFeatures, in out _TData extends RowData> {
+  /**
+   * Builds column-id to index records for each visible pinning region.
+   *
+   * This is the memoized source that `column.getIndex` reads from; most apps
+   * will not need to call it directly.
+   */
+  getColumnIndexes: () => ColumnIndexes;
   /**
    * Resets `columnOrder` to `initialState.columnOrder`.
    *
@@ -52,5 +76,4 @@ interface Table_ColumnOrdering<TFeatures extends TableFeatures, TData extends Ro
   setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
 }
 //#endregion
-export { ColumnOrderDefaultOptions, ColumnOrderState, Column_ColumnOrdering, TableOptions_ColumnOrdering, TableState_ColumnOrdering, Table_ColumnOrdering };
-//# sourceMappingURL=columnOrderingFeature.types.d.ts.map
+export { ColumnIndexes, ColumnOrderDefaultOptions, ColumnOrderState, Column_ColumnOrdering, TableOptions_ColumnOrdering, TableState_ColumnOrdering, Table_ColumnOrdering };

package/dist/features/column-ordering/columnOrderingFeature.utils.d.ts

@@ -1,10 +1,9 @@
 import { CellData, RowData, Updater } from "../../types/type-utils.js";
 import { ColumnPinningPosition } from "../column-pinning/columnPinningFeature.types.js";
-import { ColumnOrderState } from "./columnOrderingFeature.types.js";
-import { Column_Internal } from "../../types/Column.js";
+import { ColumnIndexes, ColumnOrderState } from "./columnOrderingFeature.types.js";
+import { Column } from "../../types/Column.js";
+import { Table } from "../../types/Table.js";
 import { TableFeatures } from "../../types/TableFeatures.js";
-import { Table_Internal } from "../../types/Table.js";
-
 //#region src/features/column-ordering/columnOrderingFeature.utils.d.ts
 /**
  * Creates the default column order state.
@@ -18,10 +17,22 @@ import { Table_Internal } from "../../types/Table.js";
  * ```
  */
 declare function getDefaultColumnOrderState(): ColumnOrderState;
+/**
+ * Builds column-id to index records for each visible pinning region.
+ *
+ * All four regions are built in one pass so a single memo entry serves every
+ * `column_getIndex` lookup without per-column scans.
+ *
+ * @example
+ * ```ts
+ * const indexes = table_getColumnIndexes(table)
+ * ```
+ */
+declare function table_getColumnIndexes<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): ColumnIndexes;
 /**
  * Finds this column's index within a visible pinning region.
  *
- * Pass `'left'`, `'center'`, or `'right'` to search that region; omit the
+ * Pass `'start'`, `'center'`, or `'end'` to search that region; omit the
  * position to search the full visible leaf column list.
  *
  * @example
@@ -29,7 +40,7 @@ declare function getDefaultColumnOrderState(): ColumnOrderState;
  * const index = column_getIndex(column, 'center')
  * ```
  */
-declare function column_getIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, position?: ColumnPinningPosition | 'center'): number;
+declare function column_getIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>, position?: ColumnPinningPosition | 'center'): number;
 /**
  * Checks whether this column is the first visible column in a pinning region.
  *
@@ -37,10 +48,10 @@ declare function column_getIndex<TFeatures extends TableFeatures, TData extends
  *
  * @example
  * ```ts
- * const isFirst = column_getIsFirstColumn(column, 'left')
+ * const isFirst = column_getIsFirstColumn(column, 'start')
  * ```
  */
-declare function column_getIsFirstColumn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, position?: ColumnPinningPosition | 'center'): boolean;
+declare function column_getIsFirstColumn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>, position?: ColumnPinningPosition | 'center'): boolean;
 /**
  * Checks whether this column is the last visible column in a pinning region.
  *
@@ -48,10 +59,10 @@ declare function column_getIsFirstColumn<TFeatures extends TableFeatures, TData
  *
  * @example
  * ```ts
- * const isLast = column_getIsLastColumn(column, 'right')
+ * const isLast = column_getIsLastColumn(column, 'end')
  * ```
  */
-declare function column_getIsLastColumn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, position?: ColumnPinningPosition | 'center'): boolean;
+declare function column_getIsLastColumn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>, position?: ColumnPinningPosition | 'center'): boolean;
 /**
  * Routes a column order updater through the table's column-order change handler.
  *
@@ -63,7 +74,7 @@ declare function column_getIsLastColumn<TFeatures extends TableFeatures, TData e
  * table_setColumnOrder(table, ['firstName', 'lastName', 'age'])
  * ```
  */
-declare function table_setColumnOrder<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnOrderState>): void;
+declare function table_setColumnOrder<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, updater: Updater<ColumnOrderState>): void;
 /**
  * Resets `columnOrder` to the configured initial state or feature default.
  *
@@ -76,7 +87,7 @@ declare function table_setColumnOrder<TFeatures extends TableFeatures, TData ext
  * table_resetColumnOrder(table, true)
  * ```
  */
-declare function table_resetColumnOrder<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+declare function table_resetColumnOrder<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, defaultState?: boolean): void;
 /**
  * Creates the ordering function used to arrange leaf columns.
  *
@@ -88,7 +99,7 @@ declare function table_resetColumnOrder<TFeatures extends TableFeatures, TData e
  * const orderColumnsForTable = table_getOrderColumnsFn(table)
  * ```
  */
-declare function table_getOrderColumnsFn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (columns: Array<Column_Internal<TFeatures, TData, unknown>>) => Column_Internal<TFeatures, TData, unknown>[];
+declare function table_getOrderColumnsFn<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): (columns: Array<Column<TFeatures, TData, unknown>>) => Column<TFeatures, TData, unknown>[];
 /**
  * Applies grouped-column placement rules to an already ordered leaf-column list.
  *
@@ -101,7 +112,6 @@ declare function table_getOrderColumnsFn<TFeatures extends TableFeatures, TData
  * const orderedColumns = orderColumns(table, leafColumns)
  * ```
  */
-declare function orderColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, leafColumns: Array<Column_Internal<TFeatures, TData, unknown>>): Column_Internal<TFeatures, TData, unknown>[];
+declare function orderColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, leafColumns: Array<Column<TFeatures, TData, unknown>>): Column<TFeatures, TData, unknown>[];
 //#endregion
-export { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, orderColumns, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder };
-//# sourceMappingURL=columnOrderingFeature.utils.d.ts.map
+export { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, orderColumns, table_getColumnIndexes, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder };

package/dist/features/column-ordering/columnOrderingFeature.utils.js

@@ -1,4 +1,4 @@
-import { cloneState } from "../../utils.js";
+import { callMemoOrStaticFn, cloneState, makeObjectMap } from "../../utils.js";
 import { table_getPinnedVisibleLeafColumns } from "../column-pinning/columnPinningFeature.utils.js";
 
 //#region src/features/column-ordering/columnOrderingFeature.utils.ts
@@ -17,9 +17,33 @@ function getDefaultColumnOrderState() {
 	return [];
 }
 /**
+* Builds column-id to index records for each visible pinning region.
+*
+* All four regions are built in one pass so a single memo entry serves every
+* `column_getIndex` lookup without per-column scans.
+*
+* @example
+* ```ts
+* const indexes = table_getColumnIndexes(table)
+* ```
+*/
+function table_getColumnIndexes(table) {
+	const buildIndexes = (columns) => {
+		const indexes = makeObjectMap();
+		for (let i = 0; i < columns.length; i++) indexes[columns[i].id] = i;
+		return indexes;
+	};
+	return {
+		all: buildIndexes(table_getPinnedVisibleLeafColumns(table)),
+		center: buildIndexes(table_getPinnedVisibleLeafColumns(table, "center")),
+		start: buildIndexes(table_getPinnedVisibleLeafColumns(table, "start")),
+		end: buildIndexes(table_getPinnedVisibleLeafColumns(table, "end"))
+	};
+}
+/**
 * Finds this column's index within a visible pinning region.
 *
-* Pass `'left'`, `'center'`, or `'right'` to search that region; omit the
+* Pass `'start'`, `'center'`, or `'end'` to search that region; omit the
 * position to search the full visible leaf column list.
 *
 * @example
@@ -28,7 +52,7 @@ function getDefaultColumnOrderState() {
 * ```
 */
 function column_getIndex(column, position) {
-	return table_getPinnedVisibleLeafColumns(column.table, position).findIndex((d) => d.id === column.id);
+	return callMemoOrStaticFn(column.table, "getColumnIndexes", table_getColumnIndexes)[position === "start" ? "start" : position === "end" ? "end" : position === "center" ? "center" : "all"][column.id] ?? -1;
 }
 /**
 * Checks whether this column is the first visible column in a pinning region.
@@ -37,12 +61,11 @@ function column_getIndex(column, position) {
 *
 * @example
 * ```ts
-* const isFirst = column_getIsFirstColumn(column, 'left')
+* const isFirst = column_getIsFirstColumn(column, 'start')
 * ```
 */
 function column_getIsFirstColumn(column, position) {
-	var _columns$;
-	return ((_columns$ = table_getPinnedVisibleLeafColumns(column.table, position)[0]) === null || _columns$ === void 0 ? void 0 : _columns$.id) === column.id;
+	return table_getPinnedVisibleLeafColumns(column.table, position)[0]?.id === column.id;
 }
 /**
 * Checks whether this column is the last visible column in a pinning region.
@@ -51,13 +74,12 @@ function column_getIsFirstColumn(column, position) {
 *
 * @example
 * ```ts
-* const isLast = column_getIsLastColumn(column, 'right')
+* const isLast = column_getIsLastColumn(column, 'end')
 * ```
 */
 function column_getIsLastColumn(column, position) {
-	var _columns;
 	const columns = table_getPinnedVisibleLeafColumns(column.table, position);
-	return ((_columns = columns[columns.length - 1]) === null || _columns === void 0 ? void 0 : _columns.id) === column.id;
+	return columns[columns.length - 1]?.id === column.id;
 }
 /**
 * Routes a column order updater through the table's column-order change handler.
@@ -71,8 +93,7 @@ function column_getIsLastColumn(column, position) {
 * ```
 */
 function table_setColumnOrder(table, updater) {
-	var _table$options$onColu, _table$options;
-	(_table$options$onColu = (_table$options = table.options).onColumnOrderChange) === null || _table$options$onColu === void 0 || _table$options$onColu.call(_table$options, updater);
+	table.options.onColumnOrderChange?.(updater);
 }
 /**
 * Resets `columnOrder` to the configured initial state or feature default.
@@ -101,11 +122,10 @@ function table_resetColumnOrder(table, defaultState) {
 * ```
 */
 function table_getOrderColumnsFn(table) {
-	var _table$atoms$columnOr;
-	const columnOrder = (_table$atoms$columnOr = table.atoms.columnOrder) === null || _table$atoms$columnOr === void 0 ? void 0 : _table$atoms$columnOr.get();
+	const columnOrder = table.atoms.columnOrder?.get();
 	return (columns) => {
 		let orderedColumns = [];
-		if (!(columnOrder === null || columnOrder === void 0 ? void 0 : columnOrder.length)) orderedColumns = columns;
+		if (!columnOrder?.length) orderedColumns = columns;
 		else {
 			const remaining = /* @__PURE__ */ new Map();
 			for (let i = 0; i < columns.length; i++) {
@@ -141,8 +161,7 @@ function table_getOrderColumnsFn(table) {
 * ```
 */
 function orderColumns(table, leafColumns) {
-	var _table$atoms$grouping;
-	const grouping = ((_table$atoms$grouping = table.atoms.grouping) === null || _table$atoms$grouping === void 0 ? void 0 : _table$atoms$grouping.get()) ?? [];
+	const grouping = table.atoms.grouping?.get() ?? [];
 	const { groupedColumnMode } = table.options;
 	if (!grouping.length || !groupedColumnMode) return leafColumns;
 	const nonGroupingColumns = leafColumns.filter((col) => !grouping.includes(col.id));
@@ -161,5 +180,4 @@ function orderColumns(table, leafColumns) {
 }
 
 //#endregion
-export { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, orderColumns, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder };
-//# sourceMappingURL=columnOrderingFeature.utils.js.map
+export { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, orderColumns, table_getColumnIndexes, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder };

package/dist/features/column-pinning/columnPinningFeature.d.ts

@@ -1,10 +1,13 @@
 import { TableFeature } from "../../types/TableFeatures.js";
-
 //#region src/features/column-pinning/columnPinningFeature.d.ts
 /**
- * Feature that adds column pinning state and APIs for left, center, and right regions.
+ * Feature that adds column pinning state and APIs for logical start, center,
+ * and end regions.
+ *
+ * In LTR languages/layouts, start usually corresponds to left and end to
+ * right. In RTL languages/layouts, start usually corresponds to right and end
+ * to left.
  */
 declare const columnPinningFeature: TableFeature;
 //#endregion
-export { columnPinningFeature };
-//# sourceMappingURL=columnPinningFeature.d.ts.map
+export { columnPinningFeature };