@tanstack/table-core 8.17.3 → 9.0.0-alpha.0

package/dist/cjs/features/RowSorting.cjs

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const sortingFns = require("../sortingFns.cjs");
+const utils = require("../utils.cjs");
+const RowSorting = {
+  getInitialState: (state) => {
+    return {
+      sorting: [],
+      ...state
+    };
+  },
+  getDefaultColumnDef: () => {
+    return {
+      sortingFn: "auto",
+      sortUndefined: 1
+    };
+  },
+  getDefaultOptions: (table) => {
+    return {
+      onSortingChange: utils.makeStateUpdater("sorting", table),
+      isMultiSortEvent: (e) => {
+        return e.shiftKey;
+      }
+    };
+  },
+  createColumn: (column, table) => {
+    column.getAutoSortingFn = () => {
+      const firstRows = table.getFilteredRowModel().flatRows.slice(10);
+      let isString = false;
+      for (const row of firstRows) {
+        const value = row == null ? void 0 : row.getValue(column.id);
+        if (Object.prototype.toString.call(value) === "[object Date]") {
+          return sortingFns.sortingFns.datetime;
+        }
+        if (typeof value === "string") {
+          isString = true;
+          if (value.split(sortingFns.reSplitAlphaNumeric).length > 1) {
+            return sortingFns.sortingFns.alphanumeric;
+          }
+        }
+      }
+      if (isString) {
+        return sortingFns.sortingFns.text;
+      }
+      return sortingFns.sortingFns.basic;
+    };
+    column.getAutoSortDir = () => {
+      const firstRow = table.getFilteredRowModel().flatRows[0];
+      const value = firstRow == null ? void 0 : firstRow.getValue(column.id);
+      if (typeof value === "string") {
+        return "asc";
+      }
+      return "desc";
+    };
+    column.getSortingFn = () => {
+      var _a;
+      if (!column) {
+        throw new Error();
+      }
+      return utils.isFunction(column.columnDef.sortingFn) ? column.columnDef.sortingFn : column.columnDef.sortingFn === "auto" ? column.getAutoSortingFn() : ((_a = table.options.sortingFns) == null ? void 0 : _a[column.columnDef.sortingFn]) ?? sortingFns.sortingFns[column.columnDef.sortingFn];
+    };
+    column.toggleSorting = (desc, multi) => {
+      const nextSortingOrder = column.getNextSortingOrder();
+      const hasManualValue = typeof desc !== "undefined" && desc !== null;
+      table.setSorting((old) => {
+        const existingSorting = old == null ? void 0 : old.find((d) => d.id === column.id);
+        const existingIndex = old == null ? void 0 : old.findIndex((d) => d.id === column.id);
+        let newSorting = [];
+        let sortAction;
+        let nextDesc = hasManualValue ? desc : nextSortingOrder === "desc";
+        if ((old == null ? void 0 : old.length) && column.getCanMultiSort() && multi) {
+          if (existingSorting) {
+            sortAction = "toggle";
+          } else {
+            sortAction = "add";
+          }
+        } else {
+          if ((old == null ? void 0 : old.length) && existingIndex !== old.length - 1) {
+            sortAction = "replace";
+          } else if (existingSorting) {
+            sortAction = "toggle";
+          } else {
+            sortAction = "replace";
+          }
+        }
+        if (sortAction === "toggle") {
+          if (!hasManualValue) {
+            if (!nextSortingOrder) {
+              sortAction = "remove";
+            }
+          }
+        }
+        if (sortAction === "add") {
+          newSorting = [
+            ...old,
+            {
+              id: column.id,
+              desc: nextDesc
+            }
+          ];
+          newSorting.splice(
+            0,
+            newSorting.length - (table.options.maxMultiSortColCount ?? Number.MAX_SAFE_INTEGER)
+          );
+        } else if (sortAction === "toggle") {
+          newSorting = old.map((d) => {
+            if (d.id === column.id) {
+              return {
+                ...d,
+                desc: nextDesc
+              };
+            }
+            return d;
+          });
+        } else if (sortAction === "remove") {
+          newSorting = old.filter((d) => d.id !== column.id);
+        } else {
+          newSorting = [
+            {
+              id: column.id,
+              desc: nextDesc
+            }
+          ];
+        }
+        return newSorting;
+      });
+    };
+    column.getFirstSortDir = () => {
+      const sortDescFirst = column.columnDef.sortDescFirst ?? table.options.sortDescFirst ?? column.getAutoSortDir() === "desc";
+      return sortDescFirst ? "desc" : "asc";
+    };
+    column.getNextSortingOrder = (multi) => {
+      const firstSortDirection = column.getFirstSortDir();
+      const isSorted = column.getIsSorted();
+      if (!isSorted) {
+        return firstSortDirection;
+      }
+      if (isSorted !== firstSortDirection && (table.options.enableSortingRemoval ?? true) && // If enableSortRemove, enable in general
+      (multi ? table.options.enableMultiRemove ?? true : true)) {
+        return false;
+      }
+      return isSorted === "desc" ? "asc" : "desc";
+    };
+    column.getCanSort = () => {
+      return (column.columnDef.enableSorting ?? true) && (table.options.enableSorting ?? true) && !!column.accessorFn;
+    };
+    column.getCanMultiSort = () => {
+      return column.columnDef.enableMultiSort ?? table.options.enableMultiSort ?? !!column.accessorFn;
+    };
+    column.getIsSorted = () => {
+      var _a;
+      const columnSort = (_a = table.getState().sorting) == null ? void 0 : _a.find((d) => d.id === column.id);
+      return !columnSort ? false : columnSort.desc ? "desc" : "asc";
+    };
+    column.getSortIndex = () => {
+      var _a;
+      return ((_a = table.getState().sorting) == null ? void 0 : _a.findIndex((d) => d.id === column.id)) ?? -1;
+    };
+    column.clearSorting = () => {
+      table.setSorting(
+        (old) => (old == null ? void 0 : old.length) ? old.filter((d) => d.id !== column.id) : []
+      );
+    };
+    column.getToggleSortingHandler = () => {
+      const canSort = column.getCanSort();
+      return (e) => {
+        var _a, _b, _c, _d;
+        if (!canSort)
+          return;
+        (_a = e.persist) == null ? void 0 : _a.call(e);
+        (_d = column.toggleSorting) == null ? void 0 : _d.call(
+          column,
+          void 0,
+          column.getCanMultiSort() ? (_c = (_b = table.options).isMultiSortEvent) == null ? void 0 : _c.call(_b, e) : false
+        );
+      };
+    };
+  },
+  createTable: (table) => {
+    table.setSorting = (updater) => {
+      var _a, _b;
+      return (_b = (_a = table.options).onSortingChange) == null ? void 0 : _b.call(_a, updater);
+    };
+    table.resetSorting = (defaultState) => {
+      var _a;
+      table.setSorting(defaultState ? [] : ((_a = table.initialState) == null ? void 0 : _a.sorting) ?? []);
+    };
+    table.getPreSortedRowModel = () => table.getGroupedRowModel();
+    table.getSortedRowModel = () => {
+      if (!table._getSortedRowModel && table.options.getSortedRowModel) {
+        table._getSortedRowModel = table.options.getSortedRowModel(table);
+      }
+      if (table.options.manualSorting || !table._getSortedRowModel) {
+        return table.getPreSortedRowModel();
+      }
+      return table._getSortedRowModel();
+    };
+  }
+};
+exports.RowSorting = RowSorting;
+//# sourceMappingURL=RowSorting.cjs.map

package/dist/cjs/features/RowSorting.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RowSorting.cjs","sources":["../../../src/features/RowSorting.ts"],"sourcesContent":["import { RowModel } from '..'\nimport {\n  BuiltInSortingFn,\n  reSplitAlphaNumeric,\n  sortingFns,\n} from '../sortingFns'\n\nimport {\n  Column,\n  OnChangeFn,\n  Table,\n  Row,\n  Updater,\n  RowData,\n  SortingFns,\n  TableFeature,\n} from '../types'\n\nimport { isFunction, makeStateUpdater } from '../utils'\n\nexport type SortDirection = 'asc' | 'desc'\n\nexport interface ColumnSort {\n  desc: boolean\n  id: string\n}\n\nexport type SortingState = ColumnSort[]\n\nexport interface SortingTableState {\n  sorting: SortingState\n}\n\nexport interface SortingFn<TData extends RowData> {\n  (rowA: Row<TData>, rowB: Row<TData>, columnId: string): number\n}\n\nexport type CustomSortingFns<TData extends RowData> = Record<\n  string,\n  SortingFn<TData>\n>\n\nexport type SortingFnOption<TData extends RowData> =\n  | 'auto'\n  | keyof SortingFns\n  | BuiltInSortingFn\n  | SortingFn<TData>\n\nexport interface SortingColumnDef<TData extends RowData> {\n  /**\n   * Enables/Disables multi-sorting for this column.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  enableMultiSort?: boolean\n  /**\n   * Enables/Disables sorting for this column.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  enableSorting?: boolean\n  /**\n   * 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\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  invertSorting?: boolean\n  /**\n   * Set to `true` for sorting toggles on this column to start in the descending direction.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  sortDescFirst?: boolean\n  /**\n   * The sorting function to use with this column.\n   * - A `string` referencing a built-in sorting function\n   * - A custom sorting function\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  sortingFn?: SortingFnOption<TData>\n  /**\n   * The priority of undefined values when sorting this column.\n   * - `false`\n   *   - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies)\n   * - `-1`\n   *   - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)\n   * - `1`\n   *   - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortundefined)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  sortUndefined?: false | -1 | 1 | 'first' | 'last'\n}\n\nexport interface SortingColumn<TData extends RowData> {\n  /**\n   * Removes this column from the table's sorting state\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#clearsorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  clearSorting: () => void\n  /**\n   * Returns a sort direction automatically inferred based on the columns values.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortdir)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getAutoSortDir: () => SortDirection\n  /**\n   * Returns a sorting function automatically inferred based on the columns values.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortingfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getAutoSortingFn: () => SortingFn<TData>\n  /**\n   * Returns whether this column can be multi-sorted.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcanmultisort)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getCanMultiSort: () => boolean\n  /**\n   * Returns whether this column can be sorted.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcansort)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getCanSort: () => boolean\n  /**\n   * Returns the first direction that should be used when sorting this column.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getfirstsortdir)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getFirstSortDir: () => SortDirection\n  /**\n   * Returns the current sort direction of this column.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getissorted)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getIsSorted: () => false | SortDirection\n  /**\n   * Returns the next sorting order.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getnextsortingorder)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getNextSortingOrder: () => SortDirection | false\n  /**\n   * Returns the index position of this column's sorting within the sorting state\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortindex)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getSortIndex: () => number\n  /**\n   * Returns the resolved sorting function to be used for this column\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortingfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getSortingFn: () => SortingFn<TData>\n  /**\n   * Returns a function that can be used to toggle this column's sorting state. This is useful for attaching a click handler to the column header.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#gettogglesortinghandler)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getToggleSortingHandler: () => undefined | ((event: unknown) => void)\n  /**\n   * 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).\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#togglesorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  toggleSorting: (desc?: boolean, isMulti?: boolean) => void\n}\n\ninterface SortingOptionsBase {\n  /**\n   * Enables/disables the ability to remove multi-sorts\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultiremove)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  enableMultiRemove?: boolean\n  /**\n   * Enables/Disables multi-sorting for the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  enableMultiSort?: boolean\n  /**\n   * Enables/Disables sorting for the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  enableSorting?: boolean\n  /**\n   * Enables/Disables the ability to remove sorting for the table.\n   * - If `true` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...\n   * - If `false` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ...\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesortingremoval)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  enableSortingRemoval?: boolean\n  /**\n   * This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported `getSortedRowModel()` from your adapter to your table or implement your own.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getSortedRowModel?: (table: Table<any>) => () => RowModel<any>\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#ismultisortevent)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  isMultiSortEvent?: (e: unknown) => boolean\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#manualsorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  manualSorting?: boolean\n  /**\n   * Set a maximum number of columns that can be multi-sorted.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#maxmultisortcolcount)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  maxMultiSortColCount?: number\n  /**\n   * If provided, this function will be called with an `updaterFn` when `state.sorting` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#onsortingchange)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  onSortingChange?: OnChangeFn<SortingState>\n  /**\n   * If `true`, all sorts will default to descending as their first toggle state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  sortDescFirst?: boolean\n}\n\ntype ResolvedSortingFns = keyof SortingFns extends never\n  ? {\n      sortingFns?: Record<string, SortingFn<any>>\n    }\n  : {\n      sortingFns: Record<keyof SortingFns, SortingFn<any>>\n    }\n\nexport interface SortingOptions<TData extends RowData>\n  extends SortingOptionsBase,\n    ResolvedSortingFns {}\n\nexport interface SortingInstance<TData extends RowData> {\n  _getSortedRowModel?: () => RowModel<TData>\n  /**\n   * Returns the row model for the table before any sorting has been applied.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getpresortedrowmodel)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getPreSortedRowModel: () => RowModel<TData>\n  /**\n   * Returns the row model for the table after sorting has been applied.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  getSortedRowModel: () => RowModel<TData>\n  /**\n   * Resets the **sorting** state to `initialState.sorting`, or `true` can be passed to force a default blank state reset to `[]`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#resetsorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  resetSorting: (defaultState?: boolean) => void\n  /**\n   * Sets or updates the `state.sorting` state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#setsorting)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)\n   */\n  setSorting: (updater: Updater<SortingState>) => void\n}\n\n//\n\nexport const RowSorting: TableFeature = {\n  getInitialState: (state): SortingTableState => {\n    return {\n      sorting: [],\n      ...state,\n    }\n  },\n\n  getDefaultColumnDef: <TData extends RowData>(): SortingColumnDef<TData> => {\n    return {\n      sortingFn: 'auto',\n      sortUndefined: 1,\n    }\n  },\n\n  getDefaultOptions: <TData extends RowData>(\n    table: Table<TData>\n  ): SortingOptions<TData> => {\n    return {\n      onSortingChange: makeStateUpdater('sorting', table),\n      isMultiSortEvent: (e: unknown) => {\n        return (e as MouseEvent).shiftKey\n      },\n    }\n  },\n\n  createColumn: <TData extends RowData, TValue>(\n    column: Column<TData, TValue>,\n    table: Table<TData>\n  ): void => {\n    column.getAutoSortingFn = () => {\n      const firstRows = table.getFilteredRowModel().flatRows.slice(10)\n\n      let isString = false\n\n      for (const row of firstRows) {\n        const value = row?.getValue(column.id)\n\n        if (Object.prototype.toString.call(value) === '[object Date]') {\n          return sortingFns.datetime\n        }\n\n        if (typeof value === 'string') {\n          isString = true\n\n          if (value.split(reSplitAlphaNumeric).length > 1) {\n            return sortingFns.alphanumeric\n          }\n        }\n      }\n\n      if (isString) {\n        return sortingFns.text\n      }\n\n      return sortingFns.basic\n    }\n    column.getAutoSortDir = () => {\n      const firstRow = table.getFilteredRowModel().flatRows[0]\n\n      const value = firstRow?.getValue(column.id)\n\n      if (typeof value === 'string') {\n        return 'asc'\n      }\n\n      return 'desc'\n    }\n    column.getSortingFn = () => {\n      if (!column) {\n        throw new Error()\n      }\n\n      return isFunction(column.columnDef.sortingFn)\n        ? column.columnDef.sortingFn\n        : column.columnDef.sortingFn === 'auto'\n          ? column.getAutoSortingFn()\n          : table.options.sortingFns?.[column.columnDef.sortingFn as string] ??\n            sortingFns[column.columnDef.sortingFn as BuiltInSortingFn]\n    }\n    column.toggleSorting = (desc, multi) => {\n      // if (column.columns.length) {\n      //   column.columns.forEach((c, i) => {\n      //     if (c.id) {\n      //       table.toggleColumnSorting(c.id, undefined, multi || !!i)\n      //     }\n      //   })\n      //   return\n      // }\n\n      // this needs to be outside of table.setSorting to be in sync with rerender\n      const nextSortingOrder = column.getNextSortingOrder()\n      const hasManualValue = typeof desc !== 'undefined' && desc !== null\n\n      table.setSorting(old => {\n        // Find any existing sorting for this column\n        const existingSorting = old?.find(d => d.id === column.id)\n        const existingIndex = old?.findIndex(d => d.id === column.id)\n\n        let newSorting: SortingState = []\n\n        // What should we do with this sort action?\n        let sortAction: 'add' | 'remove' | 'toggle' | 'replace'\n        let nextDesc = hasManualValue ? desc : nextSortingOrder === 'desc'\n\n        // Multi-mode\n        if (old?.length && column.getCanMultiSort() && multi) {\n          if (existingSorting) {\n            sortAction = 'toggle'\n          } else {\n            sortAction = 'add'\n          }\n        } else {\n          // Normal mode\n          if (old?.length && existingIndex !== old.length - 1) {\n            sortAction = 'replace'\n          } else if (existingSorting) {\n            sortAction = 'toggle'\n          } else {\n            sortAction = 'replace'\n          }\n        }\n\n        // Handle toggle states that will remove the sorting\n        if (sortAction === 'toggle') {\n          // If we are \"actually\" toggling (not a manual set value), should we remove the sorting?\n          if (!hasManualValue) {\n            // Is our intention to remove?\n            if (!nextSortingOrder) {\n              sortAction = 'remove'\n            }\n          }\n        }\n\n        if (sortAction === 'add') {\n          newSorting = [\n            ...old,\n            {\n              id: column.id,\n              desc: nextDesc,\n            },\n          ]\n          // Take latest n columns\n          newSorting.splice(\n            0,\n            newSorting.length -\n              (table.options.maxMultiSortColCount ?? Number.MAX_SAFE_INTEGER)\n          )\n        } else if (sortAction === 'toggle') {\n          // This flips (or sets) the\n          newSorting = old.map(d => {\n            if (d.id === column.id) {\n              return {\n                ...d,\n                desc: nextDesc,\n              }\n            }\n            return d\n          })\n        } else if (sortAction === 'remove') {\n          newSorting = old.filter(d => d.id !== column.id)\n        } else {\n          newSorting = [\n            {\n              id: column.id,\n              desc: nextDesc,\n            },\n          ]\n        }\n\n        return newSorting\n      })\n    }\n\n    column.getFirstSortDir = () => {\n      const sortDescFirst =\n        column.columnDef.sortDescFirst ??\n        table.options.sortDescFirst ??\n        column.getAutoSortDir() === 'desc'\n      return sortDescFirst ? 'desc' : 'asc'\n    }\n\n    column.getNextSortingOrder = (multi?: boolean) => {\n      const firstSortDirection = column.getFirstSortDir()\n      const isSorted = column.getIsSorted()\n\n      if (!isSorted) {\n        return firstSortDirection\n      }\n\n      if (\n        isSorted !== firstSortDirection &&\n        (table.options.enableSortingRemoval ?? true) && // If enableSortRemove, enable in general\n        (multi ? table.options.enableMultiRemove ?? true : true) // If multi, don't allow if enableMultiRemove))\n      ) {\n        return false\n      }\n      return isSorted === 'desc' ? 'asc' : 'desc'\n    }\n\n    column.getCanSort = () => {\n      return (\n        (column.columnDef.enableSorting ?? true) &&\n        (table.options.enableSorting ?? true) &&\n        !!column.accessorFn\n      )\n    }\n\n    column.getCanMultiSort = () => {\n      return (\n        column.columnDef.enableMultiSort ??\n        table.options.enableMultiSort ??\n        !!column.accessorFn\n      )\n    }\n\n    column.getIsSorted = () => {\n      const columnSort = table.getState().sorting?.find(d => d.id === column.id)\n\n      return !columnSort ? false : columnSort.desc ? 'desc' : 'asc'\n    }\n\n    column.getSortIndex = () =>\n      table.getState().sorting?.findIndex(d => d.id === column.id) ?? -1\n\n    column.clearSorting = () => {\n      //clear sorting for just 1 column\n      table.setSorting(old =>\n        old?.length ? old.filter(d => d.id !== column.id) : []\n      )\n    }\n\n    column.getToggleSortingHandler = () => {\n      const canSort = column.getCanSort()\n\n      return (e: unknown) => {\n        if (!canSort) return\n        ;(e as any).persist?.()\n        column.toggleSorting?.(\n          undefined,\n          column.getCanMultiSort() ? table.options.isMultiSortEvent?.(e) : false\n        )\n      }\n    }\n  },\n\n  createTable: <TData extends RowData>(table: Table<TData>): void => {\n    table.setSorting = updater => table.options.onSortingChange?.(updater)\n    table.resetSorting = defaultState => {\n      table.setSorting(defaultState ? [] : table.initialState?.sorting ?? [])\n    }\n    table.getPreSortedRowModel = () => table.getGroupedRowModel()\n    table.getSortedRowModel = () => {\n      if (!table._getSortedRowModel && table.options.getSortedRowModel) {\n        table._getSortedRowModel = table.options.getSortedRowModel(table)\n      }\n\n      if (table.options.manualSorting || !table._getSortedRowModel) {\n        return table.getPreSortedRowModel()\n      }\n\n      return table._getSortedRowModel()\n    }\n  },\n}\n"],"names":["makeStateUpdater","sortingFns","reSplitAlphaNumeric","isFunction"],"mappings":";;;;AAqRO,MAAM,aAA2B;AAAA,EACtC,iBAAiB,CAAC,UAA6B;AACtC,WAAA;AAAA,MACL,SAAS,CAAC;AAAA,MACV,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEA,qBAAqB,MAAsD;AAClE,WAAA;AAAA,MACL,WAAW;AAAA,MACX,eAAe;AAAA,IAAA;AAAA,EAEnB;AAAA,EAEA,mBAAmB,CACjB,UAC0B;AACnB,WAAA;AAAA,MACL,iBAAiBA,MAAAA,iBAAiB,WAAW,KAAK;AAAA,MAClD,kBAAkB,CAAC,MAAe;AAChC,eAAQ,EAAiB;AAAA,MAC3B;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,cAAc,CACZ,QACA,UACS;AACT,WAAO,mBAAmB,MAAM;AAC9B,YAAM,YAAY,MAAM,oBAAA,EAAsB,SAAS,MAAM,EAAE;AAE/D,UAAI,WAAW;AAEf,iBAAW,OAAO,WAAW;AAC3B,cAAM,QAAQ,2BAAK,SAAS,OAAO;AAEnC,YAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM,iBAAiB;AAC7D,iBAAOC,WAAAA,WAAW;AAAA,QACpB;AAEI,YAAA,OAAO,UAAU,UAAU;AAClB,qBAAA;AAEX,cAAI,MAAM,MAAMC,WAAmB,mBAAA,EAAE,SAAS,GAAG;AAC/C,mBAAOD,WAAAA,WAAW;AAAA,UACpB;AAAA,QACF;AAAA,MACF;AAEA,UAAI,UAAU;AACZ,eAAOA,WAAAA,WAAW;AAAA,MACpB;AAEA,aAAOA,WAAAA,WAAW;AAAA,IAAA;AAEpB,WAAO,iBAAiB,MAAM;AAC5B,YAAM,WAAW,MAAM,oBAAoB,EAAE,SAAS,CAAC;AAEvD,YAAM,QAAQ,qCAAU,SAAS,OAAO;AAEpC,UAAA,OAAO,UAAU,UAAU;AACtB,eAAA;AAAA,MACT;AAEO,aAAA;AAAA,IAAA;AAET,WAAO,eAAe,MAAM;;AAC1B,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI,MAAM;AAAA,MAClB;AAEO,aAAAE,iBAAW,OAAO,UAAU,SAAS,IACxC,OAAO,UAAU,YACjB,OAAO,UAAU,cAAc,SAC7B,OAAO,iBAAiB,MACxB,WAAM,QAAQ,eAAd,mBAA2B,OAAO,UAAU,eAC5CF,WAAAA,WAAW,OAAO,UAAU,SAA6B;AAAA,IAAA;AAE1D,WAAA,gBAAgB,CAAC,MAAM,UAAU;AAWhC,YAAA,mBAAmB,OAAO;AAChC,YAAM,iBAAiB,OAAO,SAAS,eAAe,SAAS;AAE/D,YAAM,WAAW,CAAO,QAAA;AAEtB,cAAM,kBAAkB,2BAAK,KAAK,OAAK,EAAE,OAAO,OAAO;AACvD,cAAM,gBAAgB,2BAAK,UAAU,OAAK,EAAE,OAAO,OAAO;AAE1D,YAAI,aAA2B,CAAA;AAG3B,YAAA;AACA,YAAA,WAAW,iBAAiB,OAAO,qBAAqB;AAG5D,aAAI,2BAAK,WAAU,OAAO,gBAAA,KAAqB,OAAO;AACpD,cAAI,iBAAiB;AACN,yBAAA;AAAA,UAAA,OACR;AACQ,yBAAA;AAAA,UACf;AAAA,QAAA,OACK;AAEL,eAAI,2BAAK,WAAU,kBAAkB,IAAI,SAAS,GAAG;AACtC,yBAAA;AAAA,qBACJ,iBAAiB;AACb,yBAAA;AAAA,UAAA,OACR;AACQ,yBAAA;AAAA,UACf;AAAA,QACF;AAGA,YAAI,eAAe,UAAU;AAE3B,cAAI,CAAC,gBAAgB;AAEnB,gBAAI,CAAC,kBAAkB;AACR,2BAAA;AAAA,YACf;AAAA,UACF;AAAA,QACF;AAEA,YAAI,eAAe,OAAO;AACX,uBAAA;AAAA,YACX,GAAG;AAAA,YACH;AAAA,cACE,IAAI,OAAO;AAAA,cACX,MAAM;AAAA,YACR;AAAA,UAAA;AAGS,qBAAA;AAAA,YACT;AAAA,YACA,WAAW,UACR,MAAM,QAAQ,wBAAwB,OAAO;AAAA,UAAA;AAAA,QAClD,WACS,eAAe,UAAU;AAErB,uBAAA,IAAI,IAAI,CAAK,MAAA;AACpB,gBAAA,EAAE,OAAO,OAAO,IAAI;AACf,qBAAA;AAAA,gBACL,GAAG;AAAA,gBACH,MAAM;AAAA,cAAA;AAAA,YAEV;AACO,mBAAA;AAAA,UAAA,CACR;AAAA,QAAA,WACQ,eAAe,UAAU;AAClC,uBAAa,IAAI,OAAO,CAAA,MAAK,EAAE,OAAO,OAAO,EAAE;AAAA,QAAA,OAC1C;AACQ,uBAAA;AAAA,YACX;AAAA,cACE,IAAI,OAAO;AAAA,cACX,MAAM;AAAA,YACR;AAAA,UAAA;AAAA,QAEJ;AAEO,eAAA;AAAA,MAAA,CACR;AAAA,IAAA;AAGH,WAAO,kBAAkB,MAAM;AACvB,YAAA,gBACJ,OAAO,UAAU,iBACjB,MAAM,QAAQ,iBACd,OAAO,eAAA,MAAqB;AAC9B,aAAO,gBAAgB,SAAS;AAAA,IAAA;AAG3B,WAAA,sBAAsB,CAAC,UAAoB;AAC1C,YAAA,qBAAqB,OAAO;AAC5B,YAAA,WAAW,OAAO;AAExB,UAAI,CAAC,UAAU;AACN,eAAA;AAAA,MACT;AAEA,UACE,aAAa,uBACZ,MAAM,QAAQ,wBAAwB;AAAA,OACtC,QAAQ,MAAM,QAAQ,qBAAqB,OAAO,OACnD;AACO,eAAA;AAAA,MACT;AACO,aAAA,aAAa,SAAS,QAAQ;AAAA,IAAA;AAGvC,WAAO,aAAa,MAAM;AAErB,cAAA,OAAO,UAAU,iBAAiB,UAClC,MAAM,QAAQ,iBAAiB,SAChC,CAAC,CAAC,OAAO;AAAA,IAAA;AAIb,WAAO,kBAAkB,MAAM;AAE3B,aAAA,OAAO,UAAU,mBACjB,MAAM,QAAQ,mBACd,CAAC,CAAC,OAAO;AAAA,IAAA;AAIb,WAAO,cAAc,MAAM;;AACnB,YAAA,cAAa,WAAM,SAAA,EAAW,YAAjB,mBAA0B,KAAK,CAAK,MAAA,EAAE,OAAO,OAAO;AAEvE,aAAO,CAAC,aAAa,QAAQ,WAAW,OAAO,SAAS;AAAA,IAAA;AAG1D,WAAO,eAAe,MACpB;;AAAA,0BAAM,SAAW,EAAA,YAAjB,mBAA0B,UAAU,CAAA,MAAK,EAAE,OAAO,OAAO,QAAO;AAAA;AAElE,WAAO,eAAe,MAAM;AAEpB,YAAA;AAAA,QAAW,CAAA,SACf,2BAAK,UAAS,IAAI,OAAO,CAAK,MAAA,EAAE,OAAO,OAAO,EAAE,IAAI,CAAC;AAAA,MAAA;AAAA,IACvD;AAGF,WAAO,0BAA0B,MAAM;AAC/B,YAAA,UAAU,OAAO;AAEvB,aAAO,CAAC,MAAe;;AACrB,YAAI,CAAC;AAAS;AACZ,gBAAU,YAAV;AACK,qBAAA,kBAAA;AAAA;AAAA,UACL;AAAA,UACA,OAAO,gBAAgB,KAAI,iBAAM,SAAQ,qBAAd,4BAAiC,KAAK;AAAA;AAAA,MACnE;AAAA,IACF;AAAA,EAEJ;AAAA,EAEA,aAAa,CAAwB,UAA8B;AACjE,UAAM,aAAa,CAAA,YAAA;;AAAW,+BAAM,SAAQ,oBAAd,4BAAgC;AAAA;AAC9D,UAAM,eAAe,CAAgB,iBAAA;;AAC7B,YAAA,WAAW,eAAe,CAAC,MAAI,WAAM,iBAAN,mBAAoB,YAAW,CAAA,CAAE;AAAA,IAAA;AAElE,UAAA,uBAAuB,MAAM,MAAM,mBAAmB;AAC5D,UAAM,oBAAoB,MAAM;AAC9B,UAAI,CAAC,MAAM,sBAAsB,MAAM,QAAQ,mBAAmB;AAChE,cAAM,qBAAqB,MAAM,QAAQ,kBAAkB,KAAK;AAAA,MAClE;AAEA,UAAI,MAAM,QAAQ,iBAAiB,CAAC,MAAM,oBAAoB;AAC5D,eAAO,MAAM;MACf;AAEA,aAAO,MAAM;IAAmB;AAAA,EAEpC;AACF;;"}

package/dist/cjs/features/RowSorting.d.cts

@@ -0,0 +1,238 @@
+import { RowModel } from '..';
+import { BuiltInSortingFn } from '../sortingFns';
+import { OnChangeFn, Table, Row, Updater, RowData, SortingFns, TableFeature } from '../types';
+
+export type SortDirection = 'asc' | 'desc';
+export interface ColumnSort {
+    desc: boolean;
+    id: string;
+}
+export type SortingState = ColumnSort[];
+export interface SortingTableState {
+    sorting: SortingState;
+}
+export interface SortingFn<TData extends RowData> {
+    (rowA: Row<TData>, rowB: Row<TData>, columnId: string): number;
+}
+export type CustomSortingFns<TData extends RowData> = Record<string, SortingFn<TData>>;
+export type SortingFnOption<TData extends RowData> = 'auto' | keyof SortingFns | BuiltInSortingFn | SortingFn<TData>;
+export interface SortingColumnDef<TData extends RowData> {
+    /**
+     * Enables/Disables multi-sorting for this column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    enableMultiSort?: boolean;
+    /**
+     * Enables/Disables sorting for this column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    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
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    invertSorting?: boolean;
+    /**
+     * Set to `true` for sorting toggles on this column to start in the descending direction.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    sortDescFirst?: boolean;
+    /**
+     * The sorting function to use with this column.
+     * - A `string` referencing a built-in sorting function
+     * - A custom sorting function
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    sortingFn?: SortingFnOption<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)
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortundefined)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    sortUndefined?: false | -1 | 1 | 'first' | 'last';
+}
+export interface SortingColumn<TData extends RowData> {
+    /**
+     * Removes this column from the table's sorting state
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#clearsorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    clearSorting: () => void;
+    /**
+     * Returns a sort direction automatically inferred based on the columns values.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortdir)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getAutoSortDir: () => SortDirection;
+    /**
+     * Returns a sorting function automatically inferred based on the columns values.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortingfn)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getAutoSortingFn: () => SortingFn<TData>;
+    /**
+     * Returns whether this column can be multi-sorted.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcanmultisort)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getCanMultiSort: () => boolean;
+    /**
+     * Returns whether this column can be sorted.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcansort)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getCanSort: () => boolean;
+    /**
+     * Returns the first direction that should be used when sorting this column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getfirstsortdir)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getFirstSortDir: () => SortDirection;
+    /**
+     * Returns the current sort direction of this column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getissorted)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getIsSorted: () => false | SortDirection;
+    /**
+     * Returns the next sorting order.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getnextsortingorder)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getNextSortingOrder: () => SortDirection | false;
+    /**
+     * Returns the index position of this column's sorting within the sorting state
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortindex)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getSortIndex: () => number;
+    /**
+     * Returns the resolved sorting function to be used for this column
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortingfn)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getSortingFn: () => SortingFn<TData>;
+    /**
+     * Returns a function that can be used to toggle this column's sorting state. This is useful for attaching a click handler to the column header.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#gettogglesortinghandler)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    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).
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#togglesorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    toggleSorting: (desc?: boolean, isMulti?: boolean) => void;
+}
+interface SortingOptionsBase {
+    /**
+     * Enables/disables the ability to remove multi-sorts
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultiremove)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    enableMultiRemove?: boolean;
+    /**
+     * Enables/Disables multi-sorting for the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    enableMultiSort?: boolean;
+    /**
+     * Enables/Disables sorting for the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    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' -> ...
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesortingremoval)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    enableSortingRemoval?: boolean;
+    /**
+     * This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported `getSortedRowModel()` from your adapter to your table or implement your own.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getSortedRowModel?: (table: Table<any>) => () => RowModel<any>;
+    /**
+     * 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.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#ismultisortevent)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    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.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#manualsorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    manualSorting?: boolean;
+    /**
+     * Set a maximum number of columns that can be multi-sorted.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#maxmultisortcolcount)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    maxMultiSortColCount?: number;
+    /**
+     * If provided, this function will be called with an `updaterFn` when `state.sorting` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#onsortingchange)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    onSortingChange?: OnChangeFn<SortingState>;
+    /**
+     * If `true`, all sorts will default to descending as their first toggle state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    sortDescFirst?: boolean;
+}
+type ResolvedSortingFns = keyof SortingFns extends never ? {
+    sortingFns?: Record<string, SortingFn<any>>;
+} : {
+    sortingFns: Record<keyof SortingFns, SortingFn<any>>;
+};
+export interface SortingOptions<TData extends RowData> extends SortingOptionsBase, ResolvedSortingFns {
+}
+export interface SortingInstance<TData extends RowData> {
+    _getSortedRowModel?: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table before any sorting has been applied.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getpresortedrowmodel)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getPreSortedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table after sorting has been applied.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    getSortedRowModel: () => RowModel<TData>;
+    /**
+     * Resets the **sorting** state to `initialState.sorting`, or `true` can be passed to force a default blank state reset to `[]`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#resetsorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    resetSorting: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.sorting` state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#setsorting)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    setSorting: (updater: Updater<SortingState>) => void;
+}
+export declare const RowSorting: TableFeature;
+export {};

package/dist/cjs/filterFns.cjs

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const includesString = (row, columnId, filterValue) => {
+  var _a, _b, _c;
+  const search = filterValue.toLowerCase();
+  return Boolean(
+    (_c = (_b = (_a = row.getValue(columnId)) == null ? void 0 : _a.toString()) == null ? void 0 : _b.toLowerCase()) == null ? void 0 : _c.includes(search)
+  );
+};
+includesString.autoRemove = (val) => testFalsey(val);
+const includesStringSensitive = (row, columnId, filterValue) => {
+  var _a, _b;
+  return Boolean(
+    (_b = (_a = row.getValue(columnId)) == null ? void 0 : _a.toString()) == null ? void 0 : _b.includes(filterValue)
+  );
+};
+includesStringSensitive.autoRemove = (val) => testFalsey(val);
+const equalsString = (row, columnId, filterValue) => {
+  var _a, _b;
+  return ((_b = (_a = row.getValue(columnId)) == null ? void 0 : _a.toString()) == null ? void 0 : _b.toLowerCase()) === (filterValue == null ? void 0 : filterValue.toLowerCase());
+};
+equalsString.autoRemove = (val) => testFalsey(val);
+const arrIncludes = (row, columnId, filterValue) => {
+  var _a;
+  return (_a = row.getValue(columnId)) == null ? void 0 : _a.includes(filterValue);
+};
+arrIncludes.autoRemove = (val) => testFalsey(val) || !(val == null ? void 0 : val.length);
+const arrIncludesAll = (row, columnId, filterValue) => {
+  return !filterValue.some(
+    (val) => {
+      var _a;
+      return !((_a = row.getValue(columnId)) == null ? void 0 : _a.includes(val));
+    }
+  );
+};
+arrIncludesAll.autoRemove = (val) => testFalsey(val) || !(val == null ? void 0 : val.length);
+const arrIncludesSome = (row, columnId, filterValue) => {
+  return filterValue.some(
+    (val) => {
+      var _a;
+      return (_a = row.getValue(columnId)) == null ? void 0 : _a.includes(val);
+    }
+  );
+};
+arrIncludesSome.autoRemove = (val) => testFalsey(val) || !(val == null ? void 0 : val.length);
+const equals = (row, columnId, filterValue) => {
+  return row.getValue(columnId) === filterValue;
+};
+equals.autoRemove = (val) => testFalsey(val);
+const weakEquals = (row, columnId, filterValue) => {
+  return row.getValue(columnId) == filterValue;
+};
+weakEquals.autoRemove = (val) => testFalsey(val);
+const inNumberRange = (row, columnId, filterValue) => {
+  let [min, max] = filterValue;
+  const rowValue = row.getValue(columnId);
+  return rowValue >= min && rowValue <= max;
+};
+inNumberRange.resolveFilterValue = (val) => {
+  let [unsafeMin, unsafeMax] = val;
+  let parsedMin = typeof unsafeMin !== "number" ? parseFloat(unsafeMin) : unsafeMin;
+  let parsedMax = typeof unsafeMax !== "number" ? parseFloat(unsafeMax) : unsafeMax;
+  let min = unsafeMin === null || Number.isNaN(parsedMin) ? -Infinity : parsedMin;
+  let max = unsafeMax === null || Number.isNaN(parsedMax) ? Infinity : parsedMax;
+  if (min > max) {
+    const temp = min;
+    min = max;
+    max = temp;
+  }
+  return [min, max];
+};
+inNumberRange.autoRemove = (val) => testFalsey(val) || testFalsey(val[0]) && testFalsey(val[1]);
+const filterFns = {
+  includesString,
+  includesStringSensitive,
+  equalsString,
+  arrIncludes,
+  arrIncludesAll,
+  arrIncludesSome,
+  equals,
+  weakEquals,
+  inNumberRange
+};
+function testFalsey(val) {
+  return val === void 0 || val === null || val === "";
+}
+exports.filterFns = filterFns;
+//# sourceMappingURL=filterFns.cjs.map

package/dist/cjs/filterFns.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterFns.cjs","sources":["../../src/filterFns.ts"],"sourcesContent":["import { FilterFn } from './features/ColumnFiltering'\n\nconst includesString: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: string\n) => {\n  const search = filterValue.toLowerCase()\n  return Boolean(\n    row\n      .getValue<string | null>(columnId)\n      ?.toString()\n      ?.toLowerCase()\n      ?.includes(search)\n  )\n}\n\nincludesString.autoRemove = (val: any) => testFalsey(val)\n\nconst includesStringSensitive: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: string\n) => {\n  return Boolean(\n    row.getValue<string | null>(columnId)?.toString()?.includes(filterValue)\n  )\n}\n\nincludesStringSensitive.autoRemove = (val: any) => testFalsey(val)\n\nconst equalsString: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: string\n) => {\n  return (\n    row.getValue<string | null>(columnId)?.toString()?.toLowerCase() ===\n    filterValue?.toLowerCase()\n  )\n}\n\nequalsString.autoRemove = (val: any) => testFalsey(val)\n\nconst arrIncludes: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: unknown\n) => {\n  return row.getValue<unknown[]>(columnId)?.includes(filterValue)\n}\n\narrIncludes.autoRemove = (val: any) => testFalsey(val) || !val?.length\n\nconst arrIncludesAll: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: unknown[]\n) => {\n  return !filterValue.some(\n    val => !row.getValue<unknown[]>(columnId)?.includes(val)\n  )\n}\n\narrIncludesAll.autoRemove = (val: any) => testFalsey(val) || !val?.length\n\nconst arrIncludesSome: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: unknown[]\n) => {\n  return filterValue.some(\n    val => row.getValue<unknown[]>(columnId)?.includes(val)\n  )\n}\n\narrIncludesSome.autoRemove = (val: any) => testFalsey(val) || !val?.length\n\nconst equals: FilterFn<any> = (row, columnId: string, filterValue: unknown) => {\n  return row.getValue(columnId) === filterValue\n}\n\nequals.autoRemove = (val: any) => testFalsey(val)\n\nconst weakEquals: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: unknown\n) => {\n  return row.getValue(columnId) == filterValue\n}\n\nweakEquals.autoRemove = (val: any) => testFalsey(val)\n\nconst inNumberRange: FilterFn<any> = (\n  row,\n  columnId: string,\n  filterValue: [number, number]\n) => {\n  let [min, max] = filterValue\n\n  const rowValue = row.getValue<number>(columnId)\n  return rowValue >= min && rowValue <= max\n}\n\ninNumberRange.resolveFilterValue = (val: [any, any]) => {\n  let [unsafeMin, unsafeMax] = val\n\n  let parsedMin =\n    typeof unsafeMin !== 'number' ? parseFloat(unsafeMin as string) : unsafeMin\n  let parsedMax =\n    typeof unsafeMax !== 'number' ? parseFloat(unsafeMax as string) : unsafeMax\n\n  let min =\n    unsafeMin === null || Number.isNaN(parsedMin) ? -Infinity : parsedMin\n  let max = unsafeMax === null || Number.isNaN(parsedMax) ? Infinity : parsedMax\n\n  if (min > max) {\n    const temp = min\n    min = max\n    max = temp\n  }\n\n  return [min, max] as const\n}\n\ninNumberRange.autoRemove = (val: any) =>\n  testFalsey(val) || (testFalsey(val[0]) && testFalsey(val[1]))\n\n// Export\n\nexport const filterFns = {\n  includesString,\n  includesStringSensitive,\n  equalsString,\n  arrIncludes,\n  arrIncludesAll,\n  arrIncludesSome,\n  equals,\n  weakEquals,\n  inNumberRange,\n}\n\nexport type BuiltInFilterFn = keyof typeof filterFns\n\n// Utils\n\nfunction testFalsey(val: any) {\n  return val === undefined || val === null || val === ''\n}\n"],"names":[],"mappings":";;AAEA,MAAM,iBAAgC,CACpC,KACA,UACA,gBACG;;AACG,QAAA,SAAS,YAAY;AACpB,SAAA;AAAA,KACL,qBACG,SAAwB,QAAQ,MADnC,mBAEI,eAFJ,mBAGI,kBAHJ,mBAII,SAAS;AAAA,EAAM;AAEvB;AAEA,eAAe,aAAa,CAAC,QAAa,WAAW,GAAG;AAExD,MAAM,0BAAyC,CAC7C,KACA,UACA,gBACG;;AACI,SAAA;AAAA,KACL,eAAI,SAAwB,QAAQ,MAApC,mBAAuC,eAAvC,mBAAmD,SAAS;AAAA,EAAW;AAE3E;AAEA,wBAAwB,aAAa,CAAC,QAAa,WAAW,GAAG;AAEjE,MAAM,eAA8B,CAClC,KACA,UACA,gBACG;;AAED,WAAA,eAAI,SAAwB,QAAQ,MAApC,mBAAuC,eAAvC,mBAAmD,oBACnD,2CAAa;AAEjB;AAEA,aAAa,aAAa,CAAC,QAAa,WAAW,GAAG;AAEtD,MAAM,cAA6B,CACjC,KACA,UACA,gBACG;;AACH,UAAO,SAAI,SAAoB,QAAQ,MAAhC,mBAAmC,SAAS;AACrD;AAEA,YAAY,aAAa,CAAC,QAAa,WAAW,GAAG,KAAK,EAAC,2BAAK;AAEhE,MAAM,iBAAgC,CACpC,KACA,UACA,gBACG;AACH,SAAO,CAAC,YAAY;AAAA,IAClB,SAAO;;AAAA,gBAAC,SAAI,SAAoB,QAAQ,MAAhC,mBAAmC,SAAS;AAAA;AAAA,EAAG;AAE3D;AAEA,eAAe,aAAa,CAAC,QAAa,WAAW,GAAG,KAAK,EAAC,2BAAK;AAEnE,MAAM,kBAAiC,CACrC,KACA,UACA,gBACG;AACH,SAAO,YAAY;AAAA,IACjB,SAAO;;AAAA,uBAAI,SAAoB,QAAQ,MAAhC,mBAAmC,SAAS;AAAA;AAAA,EAAG;AAE1D;AAEA,gBAAgB,aAAa,CAAC,QAAa,WAAW,GAAG,KAAK,EAAC,2BAAK;AAEpE,MAAM,SAAwB,CAAC,KAAK,UAAkB,gBAAyB;AACtE,SAAA,IAAI,SAAS,QAAQ,MAAM;AACpC;AAEA,OAAO,aAAa,CAAC,QAAa,WAAW,GAAG;AAEhD,MAAM,aAA4B,CAChC,KACA,UACA,gBACG;AACI,SAAA,IAAI,SAAS,QAAQ,KAAK;AACnC;AAEA,WAAW,aAAa,CAAC,QAAa,WAAW,GAAG;AAEpD,MAAM,gBAA+B,CACnC,KACA,UACA,gBACG;AACC,MAAA,CAAC,KAAK,GAAG,IAAI;AAEX,QAAA,WAAW,IAAI,SAAiB,QAAQ;AACvC,SAAA,YAAY,OAAO,YAAY;AACxC;AAEA,cAAc,qBAAqB,CAAC,QAAoB;AAClD,MAAA,CAAC,WAAW,SAAS,IAAI;AAE7B,MAAI,YACF,OAAO,cAAc,WAAW,WAAW,SAAmB,IAAI;AACpE,MAAI,YACF,OAAO,cAAc,WAAW,WAAW,SAAmB,IAAI;AAEpE,MAAI,MACF,cAAc,QAAQ,OAAO,MAAM,SAAS,IAAI,YAAY;AAC9D,MAAI,MAAM,cAAc,QAAQ,OAAO,MAAM,SAAS,IAAI,WAAW;AAErE,MAAI,MAAM,KAAK;AACb,UAAM,OAAO;AACP,UAAA;AACA,UAAA;AAAA,EACR;AAEO,SAAA,CAAC,KAAK,GAAG;AAClB;AAEA,cAAc,aAAa,CAAC,QAC1B,WAAW,GAAG,KAAM,WAAW,IAAI,CAAC,CAAC,KAAK,WAAW,IAAI,CAAC,CAAC;AAItD,MAAM,YAAY;AAAA,EACvB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAMA,SAAS,WAAW,KAAU;AAC5B,SAAO,QAAQ,UAAa,QAAQ,QAAQ,QAAQ;AACtD;;"}

package/dist/cjs/filterFns.d.cts

@@ -0,0 +1,14 @@
+import { FilterFn } from './features/ColumnFiltering.cjs';
+
+export declare const filterFns: {
+    includesString: FilterFn<any>;
+    includesStringSensitive: FilterFn<any>;
+    equalsString: FilterFn<any>;
+    arrIncludes: FilterFn<any>;
+    arrIncludesAll: FilterFn<any>;
+    arrIncludesSome: FilterFn<any>;
+    equals: FilterFn<any>;
+    weakEquals: FilterFn<any>;
+    inNumberRange: FilterFn<any>;
+};
+export type BuiltInFilterFn = keyof typeof filterFns;