@tanstack/table-core 9.0.0-alpha.43 → 9.0.0-alpha.46

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

@@ -2,16 +2,57 @@ const require_utils = require('../../utils.cjs');
 const require_sortFns = require('../../fns/sortFns.cjs');
 
 //#region src/features/row-sorting/rowSortingFeature.utils.ts
+/**
+* Returns the default sorting state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultSortingState()
+* ```
+*/
 function getDefaultSortingState() {
 	return [];
 }
+/**
+* Updates the table's sorting state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setSorting(table, (old) => old)
+* ```
+*/
 function table_setSorting(table, updater) {
 	var _table$options$onSort, _table$options;
 	(_table$options$onSort = (_table$options = table.options).onSortingChange) === null || _table$options$onSort === void 0 || _table$options$onSort.call(_table$options, updater);
 }
+/**
+* Resets the table's sorting state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetSorting(table)
+* table_resetSorting(table, true)
+* ```
+*/
 function table_resetSorting(table, defaultState) {
 	table_setSorting(table, defaultState ? [] : require_utils.cloneState(table.initialState.sorting ?? []));
 }
+/**
+* Infers sort fn for a column.
+*
+* The inference uses the column definition, table options, and sampled row values when needed.
+*
+* @example
+* ```ts
+* const value = column_getAutoSortFn(column)
+* ```
+*/
 function column_getAutoSortFn(column) {
 	const sortFns = column.table._rowModelFns.sortFns;
 	let sortFn;
@@ -28,15 +69,45 @@ function column_getAutoSortFn(column) {
 	if (isString) sortFn = sortFns === null || sortFns === void 0 ? void 0 : sortFns.text;
 	return sortFn ?? require_sortFns.sortFn_basic;
 }
+/**
+* Infers sort dir for a column.
+*
+* The inference uses the column definition, table options, and sampled row values when needed.
+*
+* @example
+* ```ts
+* const value = column_getAutoSortDir(column)
+* ```
+*/
 function column_getAutoSortDir(column) {
 	const firstRow = column.table.getFilteredRowModel().flatRows[0];
 	if (typeof (firstRow ? firstRow.getValue(column.id) : void 0) === "string") return "asc";
 	return "desc";
 }
+/**
+* Returns sort fn for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getSortFn(column)
+* ```
+*/
 function column_getSortFn(column) {
 	const sortFns = column.table._rowModelFns.sortFns;
 	return require_utils.isFunction(column.columnDef.sortFn) ? column.columnDef.sortFn : column.columnDef.sortFn === "auto" ? column_getAutoSortFn(column) : (sortFns === null || sortFns === void 0 ? void 0 : sortFns[column.columnDef.sortFn]) ?? require_sortFns.sortFn_basic;
 }
+/**
+* Toggles sorting for a column.
+*
+* The update is applied through the owning table state slice and respects the feature options for that column.
+*
+* @example
+* ```ts
+* column_toggleSorting(column)
+* ```
+*/
 function column_toggleSorting(column, desc, multi) {
 	const nextSortingOrder = column_getNextSortingOrder(column);
 	const hasManualValue = typeof desc !== "undefined";
@@ -77,9 +148,29 @@ function column_toggleSorting(column, desc, multi) {
 		return newSorting;
 	});
 }
+/**
+* Returns first sort dir for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getFirstSortDir(column)
+* ```
+*/
 function column_getFirstSortDir(column) {
 	return column.columnDef.sortDescFirst ?? column.table.options.sortDescFirst ?? column_getAutoSortDir(column) === "desc" ? "desc" : "asc";
 }
+/**
+* Returns next sorting order for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getNextSortingOrder(column)
+* ```
+*/
 function column_getNextSortingOrder(column, multi) {
 	const firstSortDirection = column_getFirstSortDir(column);
 	const isSorted = column_getIsSorted(column);
@@ -87,24 +178,84 @@ function column_getNextSortingOrder(column, multi) {
 	if (isSorted !== firstSortDirection && (column.table.options.enableSortingRemoval ?? true) && (multi ? column.table.options.enableMultiRemove ?? true : true)) return false;
 	return isSorted === "desc" ? "asc" : "desc";
 }
+/**
+* Returns whether a column can use sort.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = column_getCanSort(column)
+* ```
+*/
 function column_getCanSort(column) {
 	return (column.columnDef.enableSorting ?? true) && (column.table.options.enableSorting ?? true) && !!column.accessorFn;
 }
+/**
+* Returns whether a column can use multi sort.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = column_getCanMultiSort(column)
+* ```
+*/
 function column_getCanMultiSort(column) {
 	return column.columnDef.enableMultiSort ?? column.table.options.enableMultiSort ?? !!column.accessorFn;
 }
+/**
+* Returns is sorted for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getIsSorted(column)
+* ```
+*/
 function column_getIsSorted(column) {
 	var _column$table$atoms$s;
 	const columnSort = (_column$table$atoms$s = column.table.atoms.sorting) === null || _column$table$atoms$s === void 0 || (_column$table$atoms$s = _column$table$atoms$s.get()) === null || _column$table$atoms$s === void 0 ? void 0 : _column$table$atoms$s.find((d) => d.id === column.id);
 	return !columnSort ? false : columnSort.desc ? "desc" : "asc";
 }
+/**
+* Returns sort index for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getSortIndex(column)
+* ```
+*/
 function column_getSortIndex(column) {
 	var _column$table$atoms$s2;
 	return ((_column$table$atoms$s2 = column.table.atoms.sorting) === null || _column$table$atoms$s2 === void 0 || (_column$table$atoms$s2 = _column$table$atoms$s2.get()) === null || _column$table$atoms$s2 === void 0 ? void 0 : _column$table$atoms$s2.findIndex((d) => d.id === column.id)) ?? -1;
 }
+/**
+* Clear Sorting. for a column.
+*
+* This is the static implementation behind the matching column instance API.
+*
+* @example
+* ```ts
+* const value = column_clearSorting(column)
+* ```
+*/
 function column_clearSorting(column) {
 	table_setSorting(column.table, (old) => old.length ? old.filter((d) => d.id !== column.id) : []);
 }
+/**
+* Returns an event handler for toggling sorting handler.
+*
+* The handler is intended for direct use in column header controls such as buttons or checkboxes.
+*
+* @example
+* ```ts
+* const value = column_getToggleSortingHandler(column)
+* ```
+*/
 function column_getToggleSortingHandler(column) {
 	const canSort = column_getCanSort(column);
 	return (e) => {

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

@@ -1 +1 @@
-{"version":3,"file":"rowSortingFeature.utils.cjs","names":["cloneState","reSplitAlphaNumeric","sortFn_basic","isFunction"],"sources":["../../../src/features/row-sorting/rowSortingFeature.utils.ts"],"sourcesContent":["import { reSplitAlphaNumeric, sortFn_basic } from '../../fns/sortFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Column_Internal } from '../../types/Column'\nimport type {\n  SortDirection,\n  SortFn,\n  SortingState,\n} from './rowSortingFeature.types'\n\n// State Utils\n\nexport function getDefaultSortingState(): SortingState {\n  return []\n}\n\nexport function table_setSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<SortingState>) {\n  table.options.onSortingChange?.(updater)\n}\n\nexport function table_resetSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setSorting(\n    table,\n    defaultState ? [] : cloneState(table.initialState.sorting ?? []),\n  )\n}\n\n// Column Utils\n\nexport function column_getAutoSortFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData> {\n  const sortFns: Record<string, SortFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.sortFns\n\n  let sortFn: SortFn<TFeatures, TData> | undefined\n\n  const firstRows = column.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      sortFn = sortFns?.datetime\n    }\n\n    if (typeof value === 'string') {\n      isString = true\n\n      if (value.split(reSplitAlphaNumeric).length > 1) {\n        sortFn = sortFns?.alphanumeric\n      }\n    }\n  }\n\n  if (isString) {\n    sortFn = sortFns?.text\n  }\n\n  return sortFn ?? sortFn_basic\n}\n\nexport function column_getAutoSortDir<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const firstRow = column.table.getFilteredRowModel().flatRows[0]\n\n  const value = firstRow ? firstRow.getValue(column.id) : undefined\n\n  if (typeof value === 'string') {\n    return 'asc'\n  }\n\n  return 'desc'\n}\n\nexport function column_getSortFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData> {\n  const sortFns: Record<string, SortFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.sortFns\n\n  return isFunction(column.columnDef.sortFn)\n    ? column.columnDef.sortFn\n    : column.columnDef.sortFn === 'auto'\n      ? column_getAutoSortFn(column)\n      : (sortFns?.[column.columnDef.sortFn as string] ?? sortFn_basic)\n}\n\nexport function column_toggleSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column_Internal<TFeatures, TData, TValue>,\n  desc?: boolean,\n  multi?: boolean,\n) {\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(column)\n  const hasManualValue = typeof desc !== 'undefined'\n\n  table_setSorting(column.table, (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    const nextDesc = hasManualValue ? desc : nextSortingOrder === 'desc'\n\n    // Multi-mode\n    if (old.length && column_getCanMultiSort(column) && 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          (column.table.options.maxMultiSortColCount ??\n            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\nexport function column_getFirstSortDir<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const sortDescFirst =\n    column.columnDef.sortDescFirst ??\n    column.table.options.sortDescFirst ??\n    column_getAutoSortDir(column) === 'desc'\n  return sortDescFirst ? 'desc' : 'asc'\n}\n\nexport function column_getNextSortingOrder<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, multi?: boolean) {\n  const firstSortDirection = column_getFirstSortDir(column)\n  const isSorted = column_getIsSorted(column)\n\n  if (!isSorted) {\n    return firstSortDirection\n  }\n\n  if (\n    isSorted !== firstSortDirection &&\n    (column.table.options.enableSortingRemoval ?? true) && // If enableSortRemove, enable in general\n    (multi ? (column.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\nexport function column_getCanSort<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableSorting ?? true) &&\n    (column.table.options.enableSorting ?? true) &&\n    !!column.accessorFn\n  )\n}\n\nexport function column_getCanMultiSort<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    column.columnDef.enableMultiSort ??\n    column.table.options.enableMultiSort ??\n    !!column.accessorFn\n  )\n}\n\nexport function column_getIsSorted<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): false | SortDirection {\n  const columnSort = column.table.atoms.sorting\n    ?.get()\n    ?.find((d) => d.id === column.id)\n  return !columnSort ? false : columnSort.desc ? 'desc' : 'asc'\n}\n\nexport function column_getSortIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n  return (\n    column.table.atoms.sorting?.get()?.findIndex((d) => d.id === column.id) ??\n    -1\n  )\n}\n\nexport function column_clearSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  // clear sorting for just 1 column\n  table_setSorting(column.table, (old) =>\n    old.length ? old.filter((d) => d.id !== column.id) : [],\n  )\n}\n\nexport function column_getToggleSortingHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const canSort = column_getCanSort(column)\n\n  return (e: unknown) => {\n    if (!canSort) return\n    ;(e as any).persist?.()\n    column_toggleSorting(\n      column,\n\n      undefined,\n      column_getCanMultiSort(column)\n        ? column.table.options.isMultiSortEvent?.(e)\n        : false,\n    )\n  }\n}\n"],"mappings":";;;;AAcA,SAAgB,yBAAuC;AACrD,QAAO,EAAE;;AAGX,SAAgB,iBAGd,OAAyC,SAAgC;;AACzE,kDAAM,SAAQ,4GAAkB,QAAQ;;AAG1C,SAAgB,mBAGd,OAAyC,cAAwB;AACjE,kBACE,OACA,eAAe,EAAE,GAAGA,yBAAW,MAAM,aAAa,WAAW,EAAE,CAAC,CACjE;;AAKH,SAAgB,qBAId,QAA6E;CAC7E,MAAM,UACJ,OAAO,MAAM,aAAa;CAE5B,IAAI;CAEJ,MAAM,YAAY,OAAO,MAAM,qBAAqB,CAAC,SAAS,MAAM,GAAG;CAEvE,IAAI,WAAW;AAEf,MAAK,MAAM,OAAO,WAAW;EAC3B,MAAM,QAAQ,IAAI,SAAS,OAAO,GAAG;AAErC,MAAI,OAAO,UAAU,SAAS,KAAK,MAAM,KAAK,gBAC5C,4DAAS,QAAS;AAGpB,MAAI,OAAO,UAAU,UAAU;AAC7B,cAAW;AAEX,OAAI,MAAM,MAAMC,oCAAoB,CAAC,SAAS,EAC5C,4DAAS,QAAS;;;AAKxB,KAAI,SACF,4DAAS,QAAS;AAGpB,QAAO,UAAUC;;AAGnB,SAAgB,sBAId,QAAmD;CACnD,MAAM,WAAW,OAAO,MAAM,qBAAqB,CAAC,SAAS;AAI7D,KAAI,QAFU,WAAW,SAAS,SAAS,OAAO,GAAG,GAAG,YAEnC,SACnB,QAAO;AAGT,QAAO;;AAGT,SAAgB,iBAId,QAA6E;CAC7E,MAAM,UACJ,OAAO,MAAM,aAAa;AAE5B,QAAOC,yBAAW,OAAO,UAAU,OAAO,GACtC,OAAO,UAAU,SACjB,OAAO,UAAU,WAAW,SAC1B,qBAAqB,OAAO,sDAC3B,QAAU,OAAO,UAAU,YAAqBD;;AAGzD,SAAgB,qBAKd,QACA,MACA,OACA;CAWA,MAAM,mBAAmB,2BAA2B,OAAO;CAC3D,MAAM,iBAAiB,OAAO,SAAS;AAEvC,kBAAiB,OAAO,QAAQ,QAAQ;EAEtC,MAAM,kBAAkB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;EAC3D,MAAM,gBAAgB,IAAI,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG;EAE9D,IAAI,aAA2B,EAAE;EAGjC,IAAI;EACJ,MAAM,WAAW,iBAAiB,OAAO,qBAAqB;AAG9D,MAAI,IAAI,UAAU,uBAAuB,OAAO,IAAI,MAClD,KAAI,gBACF,cAAa;MAEb,cAAa;WAIX,IAAI,UAAU,kBAAkB,IAAI,SAAS,EAC/C,cAAa;WACJ,gBACT,cAAa;MAEb,cAAa;AAKjB,MAAI,eAAe,UAEjB;OAAI,CAAC,gBAEH;QAAI,CAAC,iBACH,cAAa;;;AAKnB,MAAI,eAAe,OAAO;AACxB,gBAAa,CACX,GAAG,KACH;IACE,IAAI,OAAO;IACX,MAAM;IACP,CACF;AAED,cAAW,OACT,GACA,WAAW,UACR,OAAO,MAAM,QAAQ,wBACpB,OAAO,kBACZ;aACQ,eAAe,SAExB,cAAa,IAAI,KAAK,MAAM;AAC1B,OAAI,EAAE,OAAO,OAAO,GAClB,QAAO;IACL,GAAG;IACH,MAAM;IACP;AAEH,UAAO;IACP;WACO,eAAe,SACxB,cAAa,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG;MAElD,cAAa,CACX;GACE,IAAI,OAAO;GACX,MAAM;GACP,CACF;AAGH,SAAO;GACP;;AAGJ,SAAgB,uBAId,QAAmD;AAKnD,QAHE,OAAO,UAAU,iBACjB,OAAO,MAAM,QAAQ,iBACrB,sBAAsB,OAAO,KAAK,SACb,SAAS;;AAGlC,SAAgB,2BAId,QAAmD,OAAiB;CACpE,MAAM,qBAAqB,uBAAuB,OAAO;CACzD,MAAM,WAAW,mBAAmB,OAAO;AAE3C,KAAI,CAAC,SACH,QAAO;AAGT,KACE,aAAa,uBACZ,OAAO,MAAM,QAAQ,wBAAwB,UAC7C,QAAS,OAAO,MAAM,QAAQ,qBAAqB,OAAQ,MAE5D,QAAO;AAET,QAAO,aAAa,SAAS,QAAQ;;AAGvC,SAAgB,kBAId,QAAmD;AACnD,SACG,OAAO,UAAU,iBAAiB,UAClC,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;;AAIb,SAAgB,uBAId,QAA4D;AAC5D,QACE,OAAO,UAAU,mBACjB,OAAO,MAAM,QAAQ,mBACrB,CAAC,CAAC,OAAO;;AAIb,SAAgB,mBAId,QAA0E;;CAC1E,MAAM,sCAAa,OAAO,MAAM,MAAM,wGAClC,KAAK,gFACL,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;AACnC,QAAO,CAAC,aAAa,QAAQ,WAAW,OAAO,SAAS;;AAG1D,SAAgB,oBAId,QAA2D;;AAC3D,mCACE,OAAO,MAAM,MAAM,2GAAS,KAAK,kFAAE,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG,KACvE;;AAIJ,SAAgB,oBAId,QAAmD;AAEnD,kBAAiB,OAAO,QAAQ,QAC9B,IAAI,SAAS,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG,GAAG,EAAE,CACxD;;AAGH,SAAgB,+BAId,QAAmD;CACnD,MAAM,UAAU,kBAAkB,OAAO;AAEzC,SAAQ,MAAe;;AACrB,MAAI,CAAC,QAAS;AACb,cAAC,EAAU,4DAAW;AACvB,uBACE,QAEA,QACA,uBAAuB,OAAO,sDAC1B,OAAO,MAAM,SAAQ,6HAAmB,EAAE,GAC1C,MACL"}
+{"version":3,"file":"rowSortingFeature.utils.cjs","names":["cloneState","reSplitAlphaNumeric","sortFn_basic","isFunction"],"sources":["../../../src/features/row-sorting/rowSortingFeature.utils.ts"],"sourcesContent":["import { reSplitAlphaNumeric, sortFn_basic } from '../../fns/sortFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Column_Internal } from '../../types/Column'\nimport type {\n  SortDirection,\n  SortFn,\n  SortingState,\n} from './rowSortingFeature.types'\n\n// State Utils\n\n/**\n * Returns the default sorting state.\n *\n * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.\n *\n * @example\n * ```ts\n * const initialValue = getDefaultSortingState()\n * ```\n */\nexport function getDefaultSortingState(): SortingState {\n  return []\n}\n\n/**\n * Updates the table's sorting state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_setSorting(table, (old) => old)\n * ```\n */\nexport function table_setSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<SortingState>) {\n  table.options.onSortingChange?.(updater)\n}\n\n/**\n * Resets the table's sorting state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_resetSorting(table)\n * table_resetSorting(table, true)\n * ```\n */\nexport function table_resetSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setSorting(\n    table,\n    defaultState ? [] : cloneState(table.initialState.sorting ?? []),\n  )\n}\n\n// Column Utils\n\n/**\n * Infers sort fn for a column.\n *\n * The inference uses the column definition, table options, and sampled row values when needed.\n *\n * @example\n * ```ts\n * const value = column_getAutoSortFn(column)\n * ```\n */\nexport function column_getAutoSortFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData> {\n  const sortFns: Record<string, SortFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.sortFns\n\n  let sortFn: SortFn<TFeatures, TData> | undefined\n\n  const firstRows = column.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      sortFn = sortFns?.datetime\n    }\n\n    if (typeof value === 'string') {\n      isString = true\n\n      if (value.split(reSplitAlphaNumeric).length > 1) {\n        sortFn = sortFns?.alphanumeric\n      }\n    }\n  }\n\n  if (isString) {\n    sortFn = sortFns?.text\n  }\n\n  return sortFn ?? sortFn_basic\n}\n\n/**\n * Infers sort dir for a column.\n *\n * The inference uses the column definition, table options, and sampled row values when needed.\n *\n * @example\n * ```ts\n * const value = column_getAutoSortDir(column)\n * ```\n */\nexport function column_getAutoSortDir<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const firstRow = column.table.getFilteredRowModel().flatRows[0]\n\n  const value = firstRow ? firstRow.getValue(column.id) : undefined\n\n  if (typeof value === 'string') {\n    return 'asc'\n  }\n\n  return 'desc'\n}\n\n/**\n * Returns sort fn for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getSortFn(column)\n * ```\n */\nexport function column_getSortFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData> {\n  const sortFns: Record<string, SortFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.sortFns\n\n  return isFunction(column.columnDef.sortFn)\n    ? column.columnDef.sortFn\n    : column.columnDef.sortFn === 'auto'\n      ? column_getAutoSortFn(column)\n      : (sortFns?.[column.columnDef.sortFn as string] ?? sortFn_basic)\n}\n\n/**\n * Toggles sorting for a column.\n *\n * The update is applied through the owning table state slice and respects the feature options for that column.\n *\n * @example\n * ```ts\n * column_toggleSorting(column)\n * ```\n */\nexport function column_toggleSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column_Internal<TFeatures, TData, TValue>,\n  desc?: boolean,\n  multi?: boolean,\n) {\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(column)\n  const hasManualValue = typeof desc !== 'undefined'\n\n  table_setSorting(column.table, (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    const nextDesc = hasManualValue ? desc : nextSortingOrder === 'desc'\n\n    // Multi-mode\n    if (old.length && column_getCanMultiSort(column) && 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          (column.table.options.maxMultiSortColCount ??\n            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/**\n * Returns first sort dir for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getFirstSortDir(column)\n * ```\n */\nexport function column_getFirstSortDir<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const sortDescFirst =\n    column.columnDef.sortDescFirst ??\n    column.table.options.sortDescFirst ??\n    column_getAutoSortDir(column) === 'desc'\n  return sortDescFirst ? 'desc' : 'asc'\n}\n\n/**\n * Returns next sorting order for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getNextSortingOrder(column)\n * ```\n */\nexport function column_getNextSortingOrder<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, multi?: boolean) {\n  const firstSortDirection = column_getFirstSortDir(column)\n  const isSorted = column_getIsSorted(column)\n\n  if (!isSorted) {\n    return firstSortDirection\n  }\n\n  if (\n    isSorted !== firstSortDirection &&\n    (column.table.options.enableSortingRemoval ?? true) && // If enableSortRemove, enable in general\n    (multi ? (column.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/**\n * Returns whether a column can use sort.\n *\n * This combines column options, table options, and any required accessor or feature state for the capability.\n *\n * @example\n * ```ts\n * const value = column_getCanSort(column)\n * ```\n */\nexport function column_getCanSort<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableSorting ?? true) &&\n    (column.table.options.enableSorting ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Returns whether a column can use multi sort.\n *\n * This combines column options, table options, and any required accessor or feature state for the capability.\n *\n * @example\n * ```ts\n * const value = column_getCanMultiSort(column)\n * ```\n */\nexport function column_getCanMultiSort<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    column.columnDef.enableMultiSort ??\n    column.table.options.enableMultiSort ??\n    !!column.accessorFn\n  )\n}\n\n/**\n * Returns is sorted for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getIsSorted(column)\n * ```\n */\nexport function column_getIsSorted<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): false | SortDirection {\n  const columnSort = column.table.atoms.sorting\n    ?.get()\n    ?.find((d) => d.id === column.id)\n  return !columnSort ? false : columnSort.desc ? 'desc' : 'asc'\n}\n\n/**\n * Returns sort index for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getSortIndex(column)\n * ```\n */\nexport function column_getSortIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n  return (\n    column.table.atoms.sorting?.get()?.findIndex((d) => d.id === column.id) ??\n    -1\n  )\n}\n\n/**\n * Clear Sorting. for a column.\n *\n * This is the static implementation behind the matching column instance API.\n *\n * @example\n * ```ts\n * const value = column_clearSorting(column)\n * ```\n */\nexport function column_clearSorting<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  // clear sorting for just 1 column\n  table_setSorting(column.table, (old) =>\n    old.length ? old.filter((d) => d.id !== column.id) : [],\n  )\n}\n\n/**\n * Returns an event handler for toggling sorting handler.\n *\n * The handler is intended for direct use in column header controls such as buttons or checkboxes.\n *\n * @example\n * ```ts\n * const value = column_getToggleSortingHandler(column)\n * ```\n */\nexport function column_getToggleSortingHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const canSort = column_getCanSort(column)\n\n  return (e: unknown) => {\n    if (!canSort) return\n    ;(e as any).persist?.()\n    column_toggleSorting(\n      column,\n\n      undefined,\n      column_getCanMultiSort(column)\n        ? column.table.options.isMultiSortEvent?.(e)\n        : false,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAwBA,SAAgB,yBAAuC;CACrD,OAAO,EAAE;;;;;;;;;;;;AAaX,SAAgB,iBAGd,OAAyC,SAAgC;;CACzE,iDAAM,SAAQ,4GAAkB,QAAQ;;;;;;;;;;;;;AAc1C,SAAgB,mBAGd,OAAyC,cAAwB;CACjE,iBACE,OACA,eAAe,EAAE,GAAGA,yBAAW,MAAM,aAAa,WAAW,EAAE,CAAC,CACjE;;;;;;;;;;;;AAeH,SAAgB,qBAId,QAA6E;CAC7E,MAAM,UACJ,OAAO,MAAM,aAAa;CAE5B,IAAI;CAEJ,MAAM,YAAY,OAAO,MAAM,qBAAqB,CAAC,SAAS,MAAM,GAAG;CAEvE,IAAI,WAAW;CAEf,KAAK,MAAM,OAAO,WAAW;EAC3B,MAAM,QAAQ,IAAI,SAAS,OAAO,GAAG;EAErC,IAAI,OAAO,UAAU,SAAS,KAAK,MAAM,KAAK,iBAC5C,2DAAS,QAAS;EAGpB,IAAI,OAAO,UAAU,UAAU;GAC7B,WAAW;GAEX,IAAI,MAAM,MAAMC,oCAAoB,CAAC,SAAS,GAC5C,2DAAS,QAAS;;;CAKxB,IAAI,UACF,2DAAS,QAAS;CAGpB,OAAO,UAAUC;;;;;;;;;;;;AAanB,SAAgB,sBAId,QAAmD;CACnD,MAAM,WAAW,OAAO,MAAM,qBAAqB,CAAC,SAAS;CAI7D,IAAI,QAFU,WAAW,SAAS,SAAS,OAAO,GAAG,GAAG,YAEnC,UACnB,OAAO;CAGT,OAAO;;;;;;;;;;;;AAaT,SAAgB,iBAId,QAA6E;CAC7E,MAAM,UACJ,OAAO,MAAM,aAAa;CAE5B,OAAOC,yBAAW,OAAO,UAAU,OAAO,GACtC,OAAO,UAAU,SACjB,OAAO,UAAU,WAAW,SAC1B,qBAAqB,OAAO,sDAC3B,QAAU,OAAO,UAAU,YAAqBD;;;;;;;;;;;;AAazD,SAAgB,qBAKd,QACA,MACA,OACA;CAWA,MAAM,mBAAmB,2BAA2B,OAAO;CAC3D,MAAM,iBAAiB,OAAO,SAAS;CAEvC,iBAAiB,OAAO,QAAQ,QAAQ;EAEtC,MAAM,kBAAkB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;EAC3D,MAAM,gBAAgB,IAAI,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG;EAE9D,IAAI,aAA2B,EAAE;EAGjC,IAAI;EACJ,MAAM,WAAW,iBAAiB,OAAO,qBAAqB;EAG9D,IAAI,IAAI,UAAU,uBAAuB,OAAO,IAAI,OAClD,IAAI,iBACF,aAAa;OAEb,aAAa;OAIf,IAAI,IAAI,UAAU,kBAAkB,IAAI,SAAS,GAC/C,aAAa;OACR,IAAI,iBACT,aAAa;OAEb,aAAa;EAKjB,IAAI,eAAe,UAEjB;OAAI,CAAC,gBAEH;QAAI,CAAC,kBACH,aAAa;;;EAKnB,IAAI,eAAe,OAAO;GACxB,aAAa,CACX,GAAG,KACH;IACE,IAAI,OAAO;IACX,MAAM;IACP,CACF;GAED,WAAW,OACT,GACA,WAAW,UACR,OAAO,MAAM,QAAQ,wBACpB,OAAO,kBACZ;SACI,IAAI,eAAe,UAExB,aAAa,IAAI,KAAK,MAAM;GAC1B,IAAI,EAAE,OAAO,OAAO,IAClB,OAAO;IACL,GAAG;IACH,MAAM;IACP;GAEH,OAAO;IACP;OACG,IAAI,eAAe,UACxB,aAAa,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG;OAElD,aAAa,CACX;GACE,IAAI,OAAO;GACX,MAAM;GACP,CACF;EAGH,OAAO;GACP;;;;;;;;;;;;AAaJ,SAAgB,uBAId,QAAmD;CAKnD,OAHE,OAAO,UAAU,iBACjB,OAAO,MAAM,QAAQ,iBACrB,sBAAsB,OAAO,KAAK,SACb,SAAS;;;;;;;;;;;;AAalC,SAAgB,2BAId,QAAmD,OAAiB;CACpE,MAAM,qBAAqB,uBAAuB,OAAO;CACzD,MAAM,WAAW,mBAAmB,OAAO;CAE3C,IAAI,CAAC,UACH,OAAO;CAGT,IACE,aAAa,uBACZ,OAAO,MAAM,QAAQ,wBAAwB,UAC7C,QAAS,OAAO,MAAM,QAAQ,qBAAqB,OAAQ,OAE5D,OAAO;CAET,OAAO,aAAa,SAAS,QAAQ;;;;;;;;;;;;AAavC,SAAgB,kBAId,QAAmD;CACnD,QACG,OAAO,UAAU,iBAAiB,UAClC,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;;;;;;;;;;;;AAcb,SAAgB,uBAId,QAA4D;CAC5D,OACE,OAAO,UAAU,mBACjB,OAAO,MAAM,QAAQ,mBACrB,CAAC,CAAC,OAAO;;;;;;;;;;;;AAcb,SAAgB,mBAId,QAA0E;;CAC1E,MAAM,sCAAa,OAAO,MAAM,MAAM,wGAClC,KAAK,gFACL,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;CACnC,OAAO,CAAC,aAAa,QAAQ,WAAW,OAAO,SAAS;;;;;;;;;;;;AAa1D,SAAgB,oBAId,QAA2D;;CAC3D,kCACE,OAAO,MAAM,MAAM,2GAAS,KAAK,kFAAE,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG,KACvE;;;;;;;;;;;;AAcJ,SAAgB,oBAId,QAAmD;CAEnD,iBAAiB,OAAO,QAAQ,QAC9B,IAAI,SAAS,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG,GAAG,EAAE,CACxD;;;;;;;;;;;;AAaH,SAAgB,+BAId,QAAmD;CACnD,MAAM,UAAU,kBAAkB,OAAO;CAEzC,QAAQ,MAAe;;EACrB,IAAI,CAAC,SAAS;EACb,YAAC,EAAU,4DAAW;EACvB,qBACE,QAEA,QACA,uBAAuB,OAAO,sDAC1B,OAAO,MAAM,SAAQ,6HAAmB,EAAE,GAC1C,MACL"}

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

@@ -5,20 +5,171 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/row-sorting/rowSortingFeature.utils.d.ts
+/**
+ * Returns the default sorting state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultSortingState()
+ * ```
+ */
 declare function getDefaultSortingState(): SortingState;
+/**
+ * Updates the table's sorting state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setSorting(table, (old) => old)
+ * ```
+ */
 declare function table_setSorting<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<SortingState>): void;
+/**
+ * Resets the table's sorting state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetSorting(table)
+ * table_resetSorting(table, true)
+ * ```
+ */
 declare function table_resetSorting<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Infers sort fn for a column.
+ *
+ * The inference uses the column definition, table options, and sampled row values when needed.
+ *
+ * @example
+ * ```ts
+ * const value = column_getAutoSortFn(column)
+ * ```
+ */
 declare function column_getAutoSortFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData>;
+/**
+ * Infers sort dir for a column.
+ *
+ * The inference uses the column definition, table options, and sampled row values when needed.
+ *
+ * @example
+ * ```ts
+ * const value = column_getAutoSortDir(column)
+ * ```
+ */
 declare function column_getAutoSortDir<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): "asc" | "desc";
+/**
+ * Returns sort fn for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getSortFn(column)
+ * ```
+ */
 declare function column_getSortFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData>;
+/**
+ * Toggles sorting for a column.
+ *
+ * The update is applied through the owning table state slice and respects the feature options for that column.
+ *
+ * @example
+ * ```ts
+ * column_toggleSorting(column)
+ * ```
+ */
 declare function column_toggleSorting<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, desc?: boolean, multi?: boolean): void;
+/**
+ * Returns first sort dir for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getFirstSortDir(column)
+ * ```
+ */
 declare function column_getFirstSortDir<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): "asc" | "desc";
+/**
+ * Returns next sorting order for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getNextSortingOrder(column)
+ * ```
+ */
 declare function column_getNextSortingOrder<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, multi?: boolean): false | "asc" | "desc";
+/**
+ * Returns whether a column can use sort.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanSort(column)
+ * ```
+ */
 declare function column_getCanSort<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns whether a column can use multi sort.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanMultiSort(column)
+ * ```
+ */
 declare function column_getCanMultiSort<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns is sorted for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getIsSorted(column)
+ * ```
+ */
 declare function column_getIsSorted<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): false | SortDirection;
+/**
+ * Returns sort index for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getSortIndex(column)
+ * ```
+ */
 declare function column_getSortIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): number;
+/**
+ * Clear Sorting. for a column.
+ *
+ * This is the static implementation behind the matching column instance API.
+ *
+ * @example
+ * ```ts
+ * const value = column_clearSorting(column)
+ * ```
+ */
 declare function column_clearSorting<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): void;
+/**
+ * Returns an event handler for toggling sorting handler.
+ *
+ * The handler is intended for direct use in column header controls such as buttons or checkboxes.
+ *
+ * @example
+ * ```ts
+ * const value = column_getToggleSortingHandler(column)
+ * ```
+ */
 declare function column_getToggleSortingHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): (e: unknown) => void;
 //#endregion
 export { 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 };

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

@@ -5,20 +5,171 @@ import { TableFeatures } from "../../types/TableFeatures.js";
 import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/row-sorting/rowSortingFeature.utils.d.ts
+/**
+ * Returns the default sorting state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultSortingState()
+ * ```
+ */
 declare function getDefaultSortingState(): SortingState;
+/**
+ * Updates the table's sorting state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setSorting(table, (old) => old)
+ * ```
+ */
 declare function table_setSorting<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<SortingState>): void;
+/**
+ * Resets the table's sorting state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetSorting(table)
+ * table_resetSorting(table, true)
+ * ```
+ */
 declare function table_resetSorting<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Infers sort fn for a column.
+ *
+ * The inference uses the column definition, table options, and sampled row values when needed.
+ *
+ * @example
+ * ```ts
+ * const value = column_getAutoSortFn(column)
+ * ```
+ */
 declare function column_getAutoSortFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData>;
+/**
+ * Infers sort dir for a column.
+ *
+ * The inference uses the column definition, table options, and sampled row values when needed.
+ *
+ * @example
+ * ```ts
+ * const value = column_getAutoSortDir(column)
+ * ```
+ */
 declare function column_getAutoSortDir<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): "asc" | "desc";
+/**
+ * Returns sort fn for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getSortFn(column)
+ * ```
+ */
 declare function column_getSortFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): SortFn<TFeatures, TData>;
+/**
+ * Toggles sorting for a column.
+ *
+ * The update is applied through the owning table state slice and respects the feature options for that column.
+ *
+ * @example
+ * ```ts
+ * column_toggleSorting(column)
+ * ```
+ */
 declare function column_toggleSorting<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, desc?: boolean, multi?: boolean): void;
+/**
+ * Returns first sort dir for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getFirstSortDir(column)
+ * ```
+ */
 declare function column_getFirstSortDir<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): "asc" | "desc";
+/**
+ * Returns next sorting order for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getNextSortingOrder(column)
+ * ```
+ */
 declare function column_getNextSortingOrder<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, multi?: boolean): false | "asc" | "desc";
+/**
+ * Returns whether a column can use sort.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanSort(column)
+ * ```
+ */
 declare function column_getCanSort<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns whether a column can use multi sort.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanMultiSort(column)
+ * ```
+ */
 declare function column_getCanMultiSort<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns is sorted for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getIsSorted(column)
+ * ```
+ */
 declare function column_getIsSorted<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): false | SortDirection;
+/**
+ * Returns sort index for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getSortIndex(column)
+ * ```
+ */
 declare function column_getSortIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): number;
+/**
+ * Clear Sorting. for a column.
+ *
+ * This is the static implementation behind the matching column instance API.
+ *
+ * @example
+ * ```ts
+ * const value = column_clearSorting(column)
+ * ```
+ */
 declare function column_clearSorting<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): void;
+/**
+ * Returns an event handler for toggling sorting handler.
+ *
+ * The handler is intended for direct use in column header controls such as buttons or checkboxes.
+ *
+ * @example
+ * ```ts
+ * const value = column_getToggleSortingHandler(column)
+ * ```
+ */
 declare function column_getToggleSortingHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): (e: unknown) => void;
 //#endregion
 export { 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 };