@tanstack/table-core 9.0.0-alpha.8 → 9.0.0-beta.10

package/dist/features/row-sorting/createSortedRowModel.d.ts

@@ -0,0 +1,18 @@
+import { RowData } from "../../types/type-utils.js";
+import { Table } from "../../types/Table.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
+
+//#region src/features/row-sorting/createSortedRowModel.d.ts
+/**
+ * Creates a memoized sorted row model factory.
+ *
+ * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+ *
+ * Register sorting functions with the `sortFns` slot on the `features` option:
+ * `tableFeatures({ rowSortingFeature, sortedRowModel: createSortedRowModel(), sortFns })`.
+ */
+declare function createSortedRowModel<TFeatures extends TableFeatures, TData extends RowData>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
+//#endregion
+export { createSortedRowModel };
+//# sourceMappingURL=createSortedRowModel.d.ts.map

package/dist/features/row-sorting/createSortedRowModel.js

@@ -0,0 +1,97 @@
+import { tableMemo } from "../../utils.js";
+import { table_autoResetPageIndex } from "../row-pagination/rowPaginationFeature.utils.js";
+import { column_getCanSort, column_getSortFn } from "./rowSortingFeature.utils.js";
+
+//#region src/features/row-sorting/createSortedRowModel.ts
+/**
+* Creates a memoized sorted row model factory.
+*
+* The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+*
+* Register sorting functions with the `sortFns` slot on the `features` option:
+* `tableFeatures({ rowSortingFeature, sortedRowModel: createSortedRowModel(), sortFns })`.
+*/
+function createSortedRowModel() {
+	return (_table) => {
+		const table = _table;
+		return tableMemo({
+			feature: "rowSortingFeature",
+			table,
+			fnName: "table.getSortedRowModel",
+			memoDeps: () => {
+				var _table$atoms$sorting;
+				return [(_table$atoms$sorting = table.atoms.sorting) === null || _table$atoms$sorting === void 0 ? void 0 : _table$atoms$sorting.get(), table.getPreSortedRowModel()];
+			},
+			fn: () => _createSortedRowModel(table),
+			onAfterUpdate: () => table_autoResetPageIndex(table)
+		});
+	};
+}
+function _createSortedRowModel(table) {
+	var _table$atoms$sorting2;
+	const preSortedRowModel = table.getPreSortedRowModel();
+	const sorting = (_table$atoms$sorting2 = table.atoms.sorting) === null || _table$atoms$sorting2 === void 0 ? void 0 : _table$atoms$sorting2.get();
+	if (!preSortedRowModel.rows.length || !(sorting === null || sorting === void 0 ? void 0 : sorting.length)) return preSortedRowModel;
+	const sortedFlatRows = [];
+	const availableSorting = sorting.filter((sort) => column_getCanSort(table.getColumn(sort.id)));
+	const columnInfoById = {};
+	availableSorting.forEach((sortEntry) => {
+		const column = table.getColumn(sortEntry.id);
+		if (!column) return;
+		columnInfoById[sortEntry.id] = {
+			sortUndefined: column.columnDef.sortUndefined,
+			invertSorting: column.columnDef.invertSorting,
+			sortFn: column_getSortFn(column)
+		};
+	});
+	const sortData = (rows) => {
+		const sortedData = rows.slice();
+		sortedData.sort((rowA, rowB) => {
+			for (let i = 0; i < availableSorting.length; i++) {
+				const sortEntry = availableSorting[i];
+				const columnInfo = columnInfoById[sortEntry.id];
+				const sortUndefined = columnInfo.sortUndefined;
+				const isDesc = sortEntry.desc;
+				let sortInt = 0;
+				if (sortUndefined) {
+					const aValue = rowA.getValue(sortEntry.id);
+					const bValue = rowB.getValue(sortEntry.id);
+					const aUndefined = aValue === void 0;
+					const bUndefined = bValue === void 0;
+					if (aUndefined || bUndefined) {
+						if (sortUndefined === "first") return aUndefined ? -1 : 1;
+						if (sortUndefined === "last") return aUndefined ? 1 : -1;
+						sortInt = aUndefined && bUndefined ? 0 : aUndefined ? sortUndefined : -sortUndefined;
+					}
+				}
+				if (sortInt === 0) sortInt = columnInfo.sortFn(rowA, rowB, sortEntry.id);
+				if (sortInt !== 0) {
+					if (isDesc) sortInt *= -1;
+					if (columnInfo.invertSorting) sortInt *= -1;
+					return sortInt;
+				}
+			}
+			return rowA.index - rowB.index;
+		});
+		for (let i = 0; i < sortedData.length; i++) {
+			const row = sortedData[i];
+			if (row.subRows.length) {
+				const cloned = Object.create(Object.getPrototypeOf(row));
+				Object.assign(cloned, row);
+				cloned.subRows = sortData(row.subRows);
+				sortedData[i] = cloned;
+				sortedFlatRows.push(cloned);
+			} else sortedFlatRows.push(row);
+		}
+		return sortedData;
+	};
+	return {
+		rows: sortData(preSortedRowModel.rows),
+		flatRows: sortedFlatRows,
+		rowsById: preSortedRowModel.rowsById
+	};
+}
+
+//#endregion
+export { createSortedRowModel };
+//# sourceMappingURL=createSortedRowModel.js.map

package/dist/features/row-sorting/createSortedRowModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSortedRowModel.js","names":[],"sources":["../../../src/features/row-sorting/createSortedRowModel.ts"],"sourcesContent":["import { tableMemo } from '../../utils'\nimport { table_autoResetPageIndex } from '../row-pagination/rowPaginationFeature.utils'\nimport { column_getCanSort, column_getSortFn } from './rowSortingFeature.utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { SortFn } from './rowSortingFeature.types'\nimport type { RowData } from '../../types/type-utils'\n\n/**\n * Creates a memoized sorted row model factory.\n *\n * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.\n *\n * Register sorting functions with the `sortFns` slot on the `features` option:\n * `tableFeatures({ rowSortingFeature, sortedRowModel: createSortedRowModel(), sortFns })`.\n */\nexport function createSortedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table = _table as unknown as Table_Internal<TFeatures, TData>\n    return tableMemo({\n      feature: 'rowSortingFeature',\n      table,\n      fnName: 'table.getSortedRowModel',\n      memoDeps: () => [\n        table.atoms.sorting?.get(),\n        table.getPreSortedRowModel(),\n      ],\n      fn: () => _createSortedRowModel(table),\n      onAfterUpdate: () => table_autoResetPageIndex(table),\n    })\n  }\n}\n\nfunction _createSortedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const preSortedRowModel = table.getPreSortedRowModel()\n  const sorting = table.atoms.sorting?.get()\n\n  if (!preSortedRowModel.rows.length || !sorting?.length) {\n    return preSortedRowModel\n  }\n\n  const sortedFlatRows: Array<Row<TFeatures, TData>> = []\n\n  // Filter out sortings that correspond to non existing columns\n  const availableSorting = sorting.filter((sort) =>\n    column_getCanSort(\n      table.getColumn(sort.id) as Column_Internal<TFeatures, TData>,\n    ),\n  )\n\n  const columnInfoById: Record<\n    string,\n    {\n      sortUndefined?: false | -1 | 1 | 'first' | 'last'\n      invertSorting?: boolean\n      sortFn: SortFn<TFeatures, TData>\n    }\n  > = {}\n\n  availableSorting.forEach((sortEntry) => {\n    const column: Column_Internal<TFeatures, TData> | undefined =\n      table.getColumn(sortEntry.id)\n    if (!column) return\n\n    columnInfoById[sortEntry.id] = {\n      sortUndefined: column.columnDef.sortUndefined,\n      invertSorting: column.columnDef.invertSorting,\n      sortFn: column_getSortFn(column),\n    }\n  })\n\n  const sortData = (rows: Array<Row<TFeatures, TData>>) => {\n    const sortedData = rows.slice()\n\n    sortedData.sort((rowA, rowB) => {\n      for (let i = 0; i < availableSorting.length; i++) {\n        const sortEntry = availableSorting[i]!\n        const columnInfo = columnInfoById[sortEntry.id]!\n        const sortUndefined = columnInfo.sortUndefined\n        const isDesc = sortEntry.desc\n\n        let sortInt = 0\n\n        // All sorting ints should always return in ascending order\n        if (sortUndefined) {\n          const aValue = rowA.getValue(sortEntry.id)\n          const bValue = rowB.getValue(sortEntry.id)\n\n          const aUndefined = aValue === undefined\n          const bUndefined = bValue === undefined\n\n          if (aUndefined || bUndefined) {\n            if (sortUndefined === 'first') return aUndefined ? -1 : 1\n            if (sortUndefined === 'last') return aUndefined ? 1 : -1\n            sortInt =\n              aUndefined && bUndefined\n                ? 0\n                : aUndefined\n                  ? sortUndefined\n                  : -sortUndefined\n          }\n        }\n\n        if (sortInt === 0) {\n          sortInt = columnInfo.sortFn(rowA, rowB, sortEntry.id)\n        }\n\n        // If sorting is non-zero, take care of desc and inversion\n        if (sortInt !== 0) {\n          if (isDesc) {\n            sortInt *= -1\n          }\n\n          if (columnInfo.invertSorting) {\n            sortInt *= -1\n          }\n\n          return sortInt\n        }\n      }\n      return rowA.index - rowB.index\n    })\n\n    // If there are sub-rows, sort them. Clone only rows that need mutation\n    // (i.e. have subRows) so we don't corrupt the source row model.\n    for (let i = 0; i < sortedData.length; i++) {\n      const row = sortedData[i]!\n      if (row.subRows.length) {\n        // Preserve prototype chain so methods like getValue() remain accessible\n        const cloned = Object.create(Object.getPrototypeOf(row))\n        Object.assign(cloned, row)\n        cloned.subRows = sortData(row.subRows)\n        sortedData[i] = cloned\n        sortedFlatRows.push(cloned)\n      } else {\n        sortedFlatRows.push(row)\n      }\n    }\n\n    return sortedData\n  }\n\n  return {\n    rows: sortData(preSortedRowModel.rows),\n    flatRows: sortedFlatRows,\n    rowsById: preSortedRowModel.rowsById,\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAmBA,SAAgB,uBAG0D;CACxE,QAAQ,WAAW;EACjB,MAAM,QAAQ;EACd,OAAO,UAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;oCACd,MAAM,MAAM,qFAAS,IAAI,GACzB,MAAM,qBAAqB,CAC7B;;GACA,UAAU,sBAAsB,KAAK;GACrC,qBAAqB,yBAAyB,KAAK;EACrD,CAAC;CACH;AACF;AAEA,SAAS,sBAGP,OAAqE;;CACrE,MAAM,oBAAoB,MAAM,qBAAqB;CACrD,MAAM,mCAAU,MAAM,MAAM,uFAAS,IAAI;CAEzC,IAAI,CAAC,kBAAkB,KAAK,UAAU,oDAAC,QAAS,SAC9C,OAAO;CAGT,MAAM,iBAA+C,CAAC;CAGtD,MAAM,mBAAmB,QAAQ,QAAQ,SACvC,kBACE,MAAM,UAAU,KAAK,EAAE,CACzB,CACF;CAEA,MAAM,iBAOF,CAAC;CAEL,iBAAiB,SAAS,cAAc;EACtC,MAAM,SACJ,MAAM,UAAU,UAAU,EAAE;EAC9B,IAAI,CAAC,QAAQ;EAEb,eAAe,UAAU,MAAM;GAC7B,eAAe,OAAO,UAAU;GAChC,eAAe,OAAO,UAAU;GAChC,QAAQ,iBAAiB,MAAM;EACjC;CACF,CAAC;CAED,MAAM,YAAY,SAAuC;EACvD,MAAM,aAAa,KAAK,MAAM;EAE9B,WAAW,MAAM,MAAM,SAAS;GAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,iBAAiB,QAAQ,KAAK;IAChD,MAAM,YAAY,iBAAiB;IACnC,MAAM,aAAa,eAAe,UAAU;IAC5C,MAAM,gBAAgB,WAAW;IACjC,MAAM,SAAS,UAAU;IAEzB,IAAI,UAAU;IAGd,IAAI,eAAe;KACjB,MAAM,SAAS,KAAK,SAAS,UAAU,EAAE;KACzC,MAAM,SAAS,KAAK,SAAS,UAAU,EAAE;KAEzC,MAAM,aAAa,WAAW;KAC9B,MAAM,aAAa,WAAW;KAE9B,IAAI,cAAc,YAAY;MAC5B,IAAI,kBAAkB,SAAS,OAAO,aAAa,KAAK;MACxD,IAAI,kBAAkB,QAAQ,OAAO,aAAa,IAAI;MACtD,UACE,cAAc,aACV,IACA,aACE,gBACA,CAAC;KACX;IACF;IAEA,IAAI,YAAY,GACd,UAAU,WAAW,OAAO,MAAM,MAAM,UAAU,EAAE;IAItD,IAAI,YAAY,GAAG;KACjB,IAAI,QACF,WAAW;KAGb,IAAI,WAAW,eACb,WAAW;KAGb,OAAO;IACT;GACF;GACA,OAAO,KAAK,QAAQ,KAAK;EAC3B,CAAC;EAID,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;GAC1C,MAAM,MAAM,WAAW;GACvB,IAAI,IAAI,QAAQ,QAAQ;IAEtB,MAAM,SAAS,OAAO,OAAO,OAAO,eAAe,GAAG,CAAC;IACvD,OAAO,OAAO,QAAQ,GAAG;IACzB,OAAO,UAAU,SAAS,IAAI,OAAO;IACrC,WAAW,KAAK;IAChB,eAAe,KAAK,MAAM;GAC5B,OACE,eAAe,KAAK,GAAG;EAE3B;EAEA,OAAO;CACT;CAEA,OAAO;EACL,MAAM,SAAS,kBAAkB,IAAI;EACrC,UAAU;EACV,UAAU,kBAAkB;CAC9B;AACF"}

package/dist/features/row-sorting/rowSortingFeature.cjs

@@ -0,0 +1,55 @@
+const require_utils = require('../../utils.cjs');
+const require_rowSortingFeature_utils = require('./rowSortingFeature.utils.cjs');
+
+//#region src/features/row-sorting/rowSortingFeature.ts
+/**
+* Feature that adds row sorting state, defaults, and column/table sorting APIs.
+*/
+const rowSortingFeature = {
+	getInitialState(initialState) {
+		return {
+			sorting: require_rowSortingFeature_utils.getDefaultSortingState(),
+			...initialState
+		};
+	},
+	getDefaultColumnDef() {
+		return {
+			sortFn: "auto",
+			sortUndefined: 1
+		};
+	},
+	getDefaultTableOptions(table) {
+		return {
+			onSortingChange: require_utils.makeStateUpdater("sorting", table),
+			isMultiSortEvent: (e) => {
+				return e.shiftKey;
+			}
+		};
+	},
+	assignColumnPrototype(prototype, table) {
+		require_utils.assignPrototypeAPIs("rowSortingFeature", prototype, table, {
+			column_getAutoSortFn: { fn: (column) => require_rowSortingFeature_utils.column_getAutoSortFn(column) },
+			column_getAutoSortDir: { fn: (column) => require_rowSortingFeature_utils.column_getAutoSortDir(column) },
+			column_getSortFn: { fn: (column) => require_rowSortingFeature_utils.column_getSortFn(column) },
+			column_toggleSorting: { fn: (column, desc, multi) => require_rowSortingFeature_utils.column_toggleSorting(column, desc, multi) },
+			column_getFirstSortDir: { fn: (column) => require_rowSortingFeature_utils.column_getFirstSortDir(column) },
+			column_getNextSortingOrder: { fn: (column, multi) => require_rowSortingFeature_utils.column_getNextSortingOrder(column, multi) },
+			column_getCanSort: { fn: (column) => require_rowSortingFeature_utils.column_getCanSort(column) },
+			column_getCanMultiSort: { fn: (column) => require_rowSortingFeature_utils.column_getCanMultiSort(column) },
+			column_getIsSorted: { fn: (column) => require_rowSortingFeature_utils.column_getIsSorted(column) },
+			column_getSortIndex: { fn: (column) => require_rowSortingFeature_utils.column_getSortIndex(column) },
+			column_clearSorting: { fn: (column) => require_rowSortingFeature_utils.column_clearSorting(column) },
+			column_getToggleSortingHandler: { fn: (column) => require_rowSortingFeature_utils.column_getToggleSortingHandler(column) }
+		});
+	},
+	constructTableAPIs(table) {
+		require_utils.assignTableAPIs("rowSortingFeature", table, {
+			table_setSorting: { fn: (updater) => require_rowSortingFeature_utils.table_setSorting(table, updater) },
+			table_resetSorting: { fn: (defaultState) => require_rowSortingFeature_utils.table_resetSorting(table, defaultState) }
+		});
+	}
+};
+
+//#endregion
+exports.rowSortingFeature = rowSortingFeature;
+//# sourceMappingURL=rowSortingFeature.cjs.map

package/dist/features/row-sorting/rowSortingFeature.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowSortingFeature.cjs","names":["getDefaultSortingState","makeStateUpdater","column_getAutoSortFn","column_getAutoSortDir","column_getSortFn","column_toggleSorting","column_getFirstSortDir","column_getNextSortingOrder","column_getCanSort","column_getCanMultiSort","column_getIsSorted","column_getSortIndex","column_clearSorting","column_getToggleSortingHandler","table_setSorting","table_resetSorting"],"sources":["../../../src/features/row-sorting/rowSortingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_clearSorting,\n  column_getAutoSortDir,\n  column_getAutoSortFn,\n  column_getCanMultiSort,\n  column_getCanSort,\n  column_getFirstSortDir,\n  column_getIsSorted,\n  column_getNextSortingOrder,\n  column_getSortFn,\n  column_getSortIndex,\n  column_getToggleSortingHandler,\n  column_toggleSorting,\n  getDefaultSortingState,\n  table_resetSorting,\n  table_setSorting,\n} from './rowSortingFeature.utils'\nimport type { TableFeature } from '../../types/TableFeatures'\n\n/**\n * Feature that adds row sorting state, defaults, and column/table sorting APIs.\n */\nexport const rowSortingFeature: TableFeature = {\n  getInitialState(initialState) {\n    return {\n      sorting: getDefaultSortingState(),\n      ...initialState,\n    }\n  },\n\n  getDefaultColumnDef() {\n    return {\n      sortFn: 'auto',\n      sortUndefined: 1,\n    }\n  },\n\n  getDefaultTableOptions(table) {\n    return {\n      onSortingChange: makeStateUpdater('sorting', table),\n      isMultiSortEvent: (e: unknown) => {\n        return (e as MouseEvent).shiftKey\n      },\n    }\n  },\n\n  assignColumnPrototype(prototype, table) {\n    assignPrototypeAPIs('rowSortingFeature', prototype, table, {\n      column_getAutoSortFn: {\n        fn: (column) => column_getAutoSortFn(column),\n      },\n      column_getAutoSortDir: {\n        fn: (column) => column_getAutoSortDir(column),\n      },\n      column_getSortFn: {\n        fn: (column) => column_getSortFn(column),\n      },\n      column_toggleSorting: {\n        fn: (column, desc, multi) => column_toggleSorting(column, desc, multi),\n      },\n      column_getFirstSortDir: {\n        fn: (column) => column_getFirstSortDir(column),\n      },\n      column_getNextSortingOrder: {\n        fn: (column, multi) => column_getNextSortingOrder(column, multi),\n      },\n      column_getCanSort: {\n        fn: (column) => column_getCanSort(column),\n      },\n      column_getCanMultiSort: {\n        fn: (column) => column_getCanMultiSort(column),\n      },\n      column_getIsSorted: {\n        fn: (column) => column_getIsSorted(column),\n      },\n      column_getSortIndex: {\n        fn: (column) => column_getSortIndex(column),\n      },\n      column_clearSorting: {\n        fn: (column) => column_clearSorting(column),\n      },\n      column_getToggleSortingHandler: {\n        fn: (column) => column_getToggleSortingHandler(column),\n      },\n    })\n  },\n\n  constructTableAPIs(table) {\n    assignTableAPIs('rowSortingFeature', table, {\n      table_setSorting: {\n        fn: (updater) => table_setSorting(table, updater),\n      },\n      table_resetSorting: {\n        fn: (defaultState) => table_resetSorting(table, defaultState),\n      },\n    })\n  },\n}\n"],"mappings":";;;;;;;AA2BA,MAAa,oBAAkC;CAC7C,gBAAgB,cAAc;EAC5B,OAAO;GACL,SAASA,uDAAuB;GAChC,GAAG;EACL;CACF;CAEA,sBAAsB;EACpB,OAAO;GACL,QAAQ;GACR,eAAe;EACjB;CACF;CAEA,uBAAuB,OAAO;EAC5B,OAAO;GACL,iBAAiBC,+BAAiB,WAAW,KAAK;GAClD,mBAAmB,MAAe;IAChC,OAAQ,EAAiB;GAC3B;EACF;CACF;CAEA,sBAAsB,WAAW,OAAO;EACtC,kCAAoB,qBAAqB,WAAW,OAAO;GACzD,sBAAsB,EACpB,KAAK,WAAWC,qDAAqB,MAAM,EAC7C;GACA,uBAAuB,EACrB,KAAK,WAAWC,sDAAsB,MAAM,EAC9C;GACA,kBAAkB,EAChB,KAAK,WAAWC,iDAAiB,MAAM,EACzC;GACA,sBAAsB,EACpB,KAAK,QAAQ,MAAM,UAAUC,qDAAqB,QAAQ,MAAM,KAAK,EACvE;GACA,wBAAwB,EACtB,KAAK,WAAWC,uDAAuB,MAAM,EAC/C;GACA,4BAA4B,EAC1B,KAAK,QAAQ,UAAUC,2DAA2B,QAAQ,KAAK,EACjE;GACA,mBAAmB,EACjB,KAAK,WAAWC,kDAAkB,MAAM,EAC1C;GACA,wBAAwB,EACtB,KAAK,WAAWC,uDAAuB,MAAM,EAC/C;GACA,oBAAoB,EAClB,KAAK,WAAWC,mDAAmB,MAAM,EAC3C;GACA,qBAAqB,EACnB,KAAK,WAAWC,oDAAoB,MAAM,EAC5C;GACA,qBAAqB,EACnB,KAAK,WAAWC,oDAAoB,MAAM,EAC5C;GACA,gCAAgC,EAC9B,KAAK,WAAWC,+DAA+B,MAAM,EACvD;EACF,CAAC;CACH;CAEA,mBAAmB,OAAO;EACxB,8BAAgB,qBAAqB,OAAO;GAC1C,kBAAkB,EAChB,KAAK,YAAYC,iDAAiB,OAAO,OAAO,EAClD;GACA,oBAAoB,EAClB,KAAK,iBAAiBC,mDAAmB,OAAO,YAAY,EAC9D;EACF,CAAC;CACH;AACF"}

package/dist/features/row-sorting/rowSortingFeature.d.cts

@@ -0,0 +1,10 @@
+import { TableFeature } from "../../types/TableFeatures.cjs";
+
+//#region src/features/row-sorting/rowSortingFeature.d.ts
+/**
+ * Feature that adds row sorting state, defaults, and column/table sorting APIs.
+ */
+declare const rowSortingFeature: TableFeature;
+//#endregion
+export { rowSortingFeature };
+//# sourceMappingURL=rowSortingFeature.d.cts.map

package/dist/features/row-sorting/rowSortingFeature.d.ts

@@ -0,0 +1,10 @@
+import { TableFeature } from "../../types/TableFeatures.js";
+
+//#region src/features/row-sorting/rowSortingFeature.d.ts
+/**
+ * Feature that adds row sorting state, defaults, and column/table sorting APIs.
+ */
+declare const rowSortingFeature: TableFeature;
+//#endregion
+export { rowSortingFeature };
+//# sourceMappingURL=rowSortingFeature.d.ts.map

package/dist/features/row-sorting/rowSortingFeature.js

@@ -0,0 +1,55 @@
+import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../utils.js";
+import { column_clearSorting, column_getAutoSortDir, column_getAutoSortFn, column_getCanMultiSort, column_getCanSort, column_getFirstSortDir, column_getIsSorted, column_getNextSortingOrder, column_getSortFn, column_getSortIndex, column_getToggleSortingHandler, column_toggleSorting, getDefaultSortingState, table_resetSorting, table_setSorting } from "./rowSortingFeature.utils.js";
+
+//#region src/features/row-sorting/rowSortingFeature.ts
+/**
+* Feature that adds row sorting state, defaults, and column/table sorting APIs.
+*/
+const rowSortingFeature = {
+	getInitialState(initialState) {
+		return {
+			sorting: getDefaultSortingState(),
+			...initialState
+		};
+	},
+	getDefaultColumnDef() {
+		return {
+			sortFn: "auto",
+			sortUndefined: 1
+		};
+	},
+	getDefaultTableOptions(table) {
+		return {
+			onSortingChange: makeStateUpdater("sorting", table),
+			isMultiSortEvent: (e) => {
+				return e.shiftKey;
+			}
+		};
+	},
+	assignColumnPrototype(prototype, table) {
+		assignPrototypeAPIs("rowSortingFeature", prototype, table, {
+			column_getAutoSortFn: { fn: (column) => column_getAutoSortFn(column) },
+			column_getAutoSortDir: { fn: (column) => column_getAutoSortDir(column) },
+			column_getSortFn: { fn: (column) => column_getSortFn(column) },
+			column_toggleSorting: { fn: (column, desc, multi) => column_toggleSorting(column, desc, multi) },
+			column_getFirstSortDir: { fn: (column) => column_getFirstSortDir(column) },
+			column_getNextSortingOrder: { fn: (column, multi) => column_getNextSortingOrder(column, multi) },
+			column_getCanSort: { fn: (column) => column_getCanSort(column) },
+			column_getCanMultiSort: { fn: (column) => column_getCanMultiSort(column) },
+			column_getIsSorted: { fn: (column) => column_getIsSorted(column) },
+			column_getSortIndex: { fn: (column) => column_getSortIndex(column) },
+			column_clearSorting: { fn: (column) => column_clearSorting(column) },
+			column_getToggleSortingHandler: { fn: (column) => column_getToggleSortingHandler(column) }
+		});
+	},
+	constructTableAPIs(table) {
+		assignTableAPIs("rowSortingFeature", table, {
+			table_setSorting: { fn: (updater) => table_setSorting(table, updater) },
+			table_resetSorting: { fn: (defaultState) => table_resetSorting(table, defaultState) }
+		});
+	}
+};
+
+//#endregion
+export { rowSortingFeature };
+//# sourceMappingURL=rowSortingFeature.js.map

package/dist/features/row-sorting/rowSortingFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowSortingFeature.js","names":[],"sources":["../../../src/features/row-sorting/rowSortingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_clearSorting,\n  column_getAutoSortDir,\n  column_getAutoSortFn,\n  column_getCanMultiSort,\n  column_getCanSort,\n  column_getFirstSortDir,\n  column_getIsSorted,\n  column_getNextSortingOrder,\n  column_getSortFn,\n  column_getSortIndex,\n  column_getToggleSortingHandler,\n  column_toggleSorting,\n  getDefaultSortingState,\n  table_resetSorting,\n  table_setSorting,\n} from './rowSortingFeature.utils'\nimport type { TableFeature } from '../../types/TableFeatures'\n\n/**\n * Feature that adds row sorting state, defaults, and column/table sorting APIs.\n */\nexport const rowSortingFeature: TableFeature = {\n  getInitialState(initialState) {\n    return {\n      sorting: getDefaultSortingState(),\n      ...initialState,\n    }\n  },\n\n  getDefaultColumnDef() {\n    return {\n      sortFn: 'auto',\n      sortUndefined: 1,\n    }\n  },\n\n  getDefaultTableOptions(table) {\n    return {\n      onSortingChange: makeStateUpdater('sorting', table),\n      isMultiSortEvent: (e: unknown) => {\n        return (e as MouseEvent).shiftKey\n      },\n    }\n  },\n\n  assignColumnPrototype(prototype, table) {\n    assignPrototypeAPIs('rowSortingFeature', prototype, table, {\n      column_getAutoSortFn: {\n        fn: (column) => column_getAutoSortFn(column),\n      },\n      column_getAutoSortDir: {\n        fn: (column) => column_getAutoSortDir(column),\n      },\n      column_getSortFn: {\n        fn: (column) => column_getSortFn(column),\n      },\n      column_toggleSorting: {\n        fn: (column, desc, multi) => column_toggleSorting(column, desc, multi),\n      },\n      column_getFirstSortDir: {\n        fn: (column) => column_getFirstSortDir(column),\n      },\n      column_getNextSortingOrder: {\n        fn: (column, multi) => column_getNextSortingOrder(column, multi),\n      },\n      column_getCanSort: {\n        fn: (column) => column_getCanSort(column),\n      },\n      column_getCanMultiSort: {\n        fn: (column) => column_getCanMultiSort(column),\n      },\n      column_getIsSorted: {\n        fn: (column) => column_getIsSorted(column),\n      },\n      column_getSortIndex: {\n        fn: (column) => column_getSortIndex(column),\n      },\n      column_clearSorting: {\n        fn: (column) => column_clearSorting(column),\n      },\n      column_getToggleSortingHandler: {\n        fn: (column) => column_getToggleSortingHandler(column),\n      },\n    })\n  },\n\n  constructTableAPIs(table) {\n    assignTableAPIs('rowSortingFeature', table, {\n      table_setSorting: {\n        fn: (updater) => table_setSorting(table, updater),\n      },\n      table_resetSorting: {\n        fn: (defaultState) => table_resetSorting(table, defaultState),\n      },\n    })\n  },\n}\n"],"mappings":";;;;;;;AA2BA,MAAa,oBAAkC;CAC7C,gBAAgB,cAAc;EAC5B,OAAO;GACL,SAAS,uBAAuB;GAChC,GAAG;EACL;CACF;CAEA,sBAAsB;EACpB,OAAO;GACL,QAAQ;GACR,eAAe;EACjB;CACF;CAEA,uBAAuB,OAAO;EAC5B,OAAO;GACL,iBAAiB,iBAAiB,WAAW,KAAK;GAClD,mBAAmB,MAAe;IAChC,OAAQ,EAAiB;GAC3B;EACF;CACF;CAEA,sBAAsB,WAAW,OAAO;EACtC,oBAAoB,qBAAqB,WAAW,OAAO;GACzD,sBAAsB,EACpB,KAAK,WAAW,qBAAqB,MAAM,EAC7C;GACA,uBAAuB,EACrB,KAAK,WAAW,sBAAsB,MAAM,EAC9C;GACA,kBAAkB,EAChB,KAAK,WAAW,iBAAiB,MAAM,EACzC;GACA,sBAAsB,EACpB,KAAK,QAAQ,MAAM,UAAU,qBAAqB,QAAQ,MAAM,KAAK,EACvE;GACA,wBAAwB,EACtB,KAAK,WAAW,uBAAuB,MAAM,EAC/C;GACA,4BAA4B,EAC1B,KAAK,QAAQ,UAAU,2BAA2B,QAAQ,KAAK,EACjE;GACA,mBAAmB,EACjB,KAAK,WAAW,kBAAkB,MAAM,EAC1C;GACA,wBAAwB,EACtB,KAAK,WAAW,uBAAuB,MAAM,EAC/C;GACA,oBAAoB,EAClB,KAAK,WAAW,mBAAmB,MAAM,EAC3C;GACA,qBAAqB,EACnB,KAAK,WAAW,oBAAoB,MAAM,EAC5C;GACA,qBAAqB,EACnB,KAAK,WAAW,oBAAoB,MAAM,EAC5C;GACA,gCAAgC,EAC9B,KAAK,WAAW,+BAA+B,MAAM,EACvD;EACF,CAAC;CACH;CAEA,mBAAmB,OAAO;EACxB,gBAAgB,qBAAqB,OAAO;GAC1C,kBAAkB,EAChB,KAAK,YAAY,iBAAiB,OAAO,OAAO,EAClD;GACA,oBAAoB,EAClB,KAAK,iBAAiB,mBAAmB,OAAO,YAAY,EAC9D;EACF,CAAC;CACH;AACF"}

package/dist/features/row-sorting/rowSortingFeature.types.d.cts

@@ -0,0 +1,191 @@
+import { OnChangeFn, RowData, Updater } from "../../types/type-utils.cjs";
+import { BuiltInSortFn } from "../../fns/sortFns.cjs";
+import { Row } from "../../types/Row.cjs";
+import { IsAny, TableFeatures } from "../../types/TableFeatures.cjs";
+import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.cjs";
+
+//#region src/features/row-sorting/rowSortingFeature.types.d.ts
+type SortDirection = 'asc' | 'desc';
+interface ColumnSort {
+  desc: boolean;
+  id: string;
+}
+type SortingState = Array<ColumnSort>;
+interface TableState_RowSorting {
+  sorting: SortingState;
+}
+interface RowModelFns_RowSorting<TFeatures extends TableFeatures, TData extends RowData> {
+  sortFns: Record<string, SortFn<TFeatures, TData>>;
+}
+interface SortFns {}
+interface SortFn<TFeatures extends TableFeatures, TData extends RowData> {
+  (rowA: Row<TFeatures, TData>, rowB: Row<TFeatures, TData>, columnId: string): number;
+}
+type CustomSortFns<TFeatures extends TableFeatures, TData extends RowData> = Record<string, SortFn<TFeatures, TData>>;
+/**
+ * Resolves the valid string names for `columnDef.sortFn` for a feature set.
+ *
+ * When the features object declares a `sortFns` registry
+ * (`tableFeatures({ ..., sortFns })`), its keys are the only valid names; a
+ * name is only assignable if a sorting function is actually registered for it.
+ * Otherwise this falls back to the global declaration-merged `SortFns`
+ * interface.
+ */
+type ExtractSortFnKeys<TFeatures extends TableFeatures> = IsAny<TFeatures> extends true ? keyof SortFns | BuiltInSortFn : TFeatures extends {
+  sortFns: infer TSortFns extends object;
+} ? Extract<keyof TSortFns, string> : keyof SortFns;
+type SortFnOption<TFeatures extends TableFeatures, TData extends RowData> = 'auto' | ExtractSortFnKeys<TFeatures> | SortFn<TFeatures, TData>;
+interface ColumnDef_RowSorting<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Enables/Disables multi-sorting for this column.
+   */
+  enableMultiSort?: boolean;
+  /**
+   * Enables/Disables sorting for this column.
+   */
+  enableSorting?: boolean;
+  /**
+   * Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring
+   */
+  invertSorting?: boolean;
+  /**
+   * Set to `true` for sorting toggles on this column to start in the descending direction.
+   */
+  sortDescFirst?: boolean;
+  /**
+   * The sorting function to use with this column.
+   * - A `string` referencing a built-in sorting function
+   * - A custom sorting function
+   */
+  sortFn?: SortFnOption<TFeatures, TData>;
+  /**
+   * The priority of undefined values when sorting this column.
+   * - `false`
+   *   - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies)
+   * - `-1`
+   *   - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
+   * - `1`
+   *   - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)
+   */
+  sortUndefined?: false | -1 | 1 | 'first' | 'last';
+}
+interface Column_RowSorting<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Removes this column from the table's sorting state
+   */
+  clearSorting: () => void;
+  /**
+   * Returns a sort direction automatically inferred based on the columns values.
+   */
+  getAutoSortDir: () => SortDirection;
+  /**
+   * Returns a sorting function automatically inferred based on the columns values.
+   */
+  getAutoSortFn: () => SortFn<TFeatures, TData>;
+  /**
+   * Returns whether this column can be multi-sorted.
+   */
+  getCanMultiSort: () => boolean;
+  /**
+   * Returns whether this column can be sorted.
+   */
+  getCanSort: () => boolean;
+  /**
+   * Returns the first direction that should be used when sorting this column.
+   */
+  getFirstSortDir: () => SortDirection;
+  /**
+   * Reads this column's current sort direction, or `false` when unsorted.
+   */
+  getIsSorted: () => false | SortDirection;
+  /**
+   * Returns the next sorting order.
+   */
+  getNextSortingOrder: () => SortDirection | false;
+  /**
+   * Finds this column's position in the ordered sorting state.
+   */
+  getSortIndex: () => number;
+  /**
+   * Returns the resolved sorting function to be used for this column
+   */
+  getSortFn: () => SortFn<TFeatures, TData>;
+  /**
+   * Creates a header/control handler that toggles this column's sorting state.
+   */
+  getToggleSortingHandler: () => undefined | ((event: unknown) => void);
+  /**
+   * Toggles this columns sorting state. If `desc` is provided, it will force the sort direction to that value. If `isMulti` is provided, it will additivity multi-sort the column (or toggle it if it is already sorted).
+   */
+  toggleSorting: (desc?: boolean, isMulti?: boolean) => void;
+}
+interface TableOptions_RowSorting {
+  /**
+   * Allows multi-sort toggles to remove a column from sorting state.
+   */
+  enableMultiRemove?: boolean;
+  /**
+   * Enables/Disables multi-sorting for the table.
+   */
+  enableMultiSort?: boolean;
+  /**
+   * Enables/Disables sorting for the table.
+   */
+  enableSorting?: boolean;
+  /**
+   * Enables/Disables the ability to remove sorting for the table.
+   * - If `true` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...
+   * - If `false` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ...
+   */
+  enableSortingRemoval?: boolean;
+  /**
+   * Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return `true` if the event should trigger a multi-sort.
+   */
+  isMultiSortEvent?: (e: unknown) => boolean;
+  /**
+   * Enables manual sorting for the table. If this is `true`, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting.
+   */
+  manualSorting?: boolean;
+  /**
+   * Set a maximum number of columns that can be multi-sorted.
+   */
+  maxMultiSortColCount?: number;
+  /**
+   * Called with an updater when sorting state changes. Pair this with
+   * `state.sorting` when using external state; external atoms can own the slice
+   * without this callback.
+   */
+  onSortingChange?: OnChangeFn<SortingState>;
+  /**
+   * If `true`, all sorts will default to descending as their first toggle state.
+   */
+  sortDescFirst?: boolean;
+}
+interface Table_RowSorting<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Resets `sorting` to `initialState.sorting`.
+   *
+   * Pass `true` to ignore initial state and reset to `[]`.
+   */
+  resetSorting: (defaultState?: boolean) => void;
+  /**
+   * Updates sorting state with a next ordered array or updater function.
+   */
+  setSorting: (updater: Updater<SortingState>) => void;
+}
+interface Table_RowModels_Sorted<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Reads the row model immediately before sorting.
+   */
+  getPreSortedRowModel: () => RowModel<TFeatures, TData>;
+  /**
+   * Resolves the row model after sorting has been applied.
+   */
+  getSortedRowModel: () => RowModel<TFeatures, TData>;
+}
+interface CachedRowModel_Sorted<TFeatures extends TableFeatures, TData extends RowData> {
+  sortedRowModel: () => RowModel<TFeatures, TData>;
+}
+//#endregion
+export { CachedRowModel_Sorted, ColumnDef_RowSorting, ColumnSort, Column_RowSorting, CustomSortFns, ExtractSortFnKeys, RowModelFns_RowSorting, SortDirection, SortFn, SortFnOption, SortFns, SortingState, TableOptions_RowSorting, TableState_RowSorting, Table_RowModels_Sorted, Table_RowSorting };
+//# sourceMappingURL=rowSortingFeature.types.d.cts.map