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

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

@@ -2,16 +2,57 @@ import { cloneState, isFunction } from "../../utils.js";
 import { reSplitAlphaNumeric, sortFn_basic } from "../../fns/sortFns.js";
 
 //#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 ? [] : 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 ?? 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 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]) ?? 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.js.map

@@ -1 +1 @@
-{"version":3,"file":"rowSortingFeature.utils.js","names":[],"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,GAAG,WAAW,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,MAAM,oBAAoB,CAAC,SAAS,EAC5C,4DAAS,QAAS;;;AAKxB,KAAI,SACF,4DAAS,QAAS;AAGpB,QAAO,UAAU;;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,QAAO,WAAW,OAAO,UAAU,OAAO,GACtC,OAAO,UAAU,SACjB,OAAO,UAAU,WAAW,SAC1B,qBAAqB,OAAO,sDAC3B,QAAU,OAAO,UAAU,YAAqB;;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.js","names":[],"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,GAAG,WAAW,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,MAAM,oBAAoB,CAAC,SAAS,GAC5C,2DAAS,QAAS;;;CAKxB,IAAI,UACF,2DAAS,QAAS;CAGpB,OAAO,UAAU;;;;;;;;;;;;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,OAAO,WAAW,OAAO,UAAU,OAAO,GACtC,OAAO,UAAU,SACjB,OAAO,UAAU,WAAW,SAC1B,qBAAqB,OAAO,sDAC3B,QAAU,OAAO,UAAU,YAAqB;;;;;;;;;;;;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/stockFeatures.cjs

@@ -14,6 +14,11 @@ const require_rowSelectionFeature = require('./row-selection/rowSelectionFeature
 const require_rowSortingFeature = require('./row-sorting/rowSortingFeature.cjs');
 
 //#region src/features/stockFeatures.ts
+/**
+* The complete set of stock optional table features.
+*
+* Use individual feature exports for tree-shaking, or this aggregate when a table should include every built-in feature.
+*/
 const stockFeatures = {
 	columnFacetingFeature: require_columnFacetingFeature.columnFacetingFeature,
 	columnFilteringFeature: require_columnFilteringFeature.columnFilteringFeature,

package/dist/features/stockFeatures.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"stockFeatures.cjs","names":[],"sources":["../../src/features/stockFeatures.ts"],"sourcesContent":["import { columnFacetingFeature } from './column-faceting/columnFacetingFeature'\nimport { columnFilteringFeature } from './column-filtering/columnFilteringFeature'\nimport { columnGroupingFeature } from './column-grouping/columnGroupingFeature'\nimport { columnOrderingFeature } from './column-ordering/columnOrderingFeature'\nimport { columnPinningFeature } from './column-pinning/columnPinningFeature'\nimport { columnResizingFeature } from './column-resizing/columnResizingFeature'\nimport { columnSizingFeature } from './column-sizing/columnSizingFeature'\nimport { columnVisibilityFeature } from './column-visibility/columnVisibilityFeature'\nimport { globalFilteringFeature } from './global-filtering/globalFilteringFeature'\nimport { rowExpandingFeature } from './row-expanding/rowExpandingFeature'\nimport { rowPaginationFeature } from './row-pagination/rowPaginationFeature'\nimport { rowPinningFeature } from './row-pinning/rowPinningFeature'\nimport { rowSelectionFeature } from './row-selection/rowSelectionFeature'\nimport { rowSortingFeature } from './row-sorting/rowSortingFeature'\n\nexport interface StockFeatures {\n  columnFacetingFeature: typeof columnFacetingFeature\n  columnFilteringFeature: typeof columnFilteringFeature\n  columnGroupingFeature: typeof columnGroupingFeature\n  columnOrderingFeature: typeof columnOrderingFeature\n  columnPinningFeature: typeof columnPinningFeature\n  columnResizingFeature: typeof columnResizingFeature\n  columnSizingFeature: typeof columnSizingFeature\n  columnVisibilityFeature: typeof columnVisibilityFeature\n  globalFilteringFeature: typeof globalFilteringFeature\n  rowExpandingFeature: typeof rowExpandingFeature\n  rowPaginationFeature: typeof rowPaginationFeature\n  rowPinningFeature: typeof rowPinningFeature\n  rowSelectionFeature: typeof rowSelectionFeature\n  rowSortingFeature: typeof rowSortingFeature\n}\n\nexport const stockFeatures: StockFeatures = {\n  columnFacetingFeature,\n  columnFilteringFeature,\n  columnGroupingFeature,\n  columnOrderingFeature,\n  columnPinningFeature,\n  columnResizingFeature,\n  columnSizingFeature,\n  columnVisibilityFeature,\n  globalFilteringFeature,\n  rowExpandingFeature,\n  rowPaginationFeature,\n  rowPinningFeature,\n  rowSelectionFeature,\n  rowSortingFeature,\n} as const\n"],"mappings":";;;;;;;;;;;;;;;;AAgCA,MAAa,gBAA+B;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD"}
+{"version":3,"file":"stockFeatures.cjs","names":[],"sources":["../../src/features/stockFeatures.ts"],"sourcesContent":["import { columnFacetingFeature } from './column-faceting/columnFacetingFeature'\nimport { columnFilteringFeature } from './column-filtering/columnFilteringFeature'\nimport { columnGroupingFeature } from './column-grouping/columnGroupingFeature'\nimport { columnOrderingFeature } from './column-ordering/columnOrderingFeature'\nimport { columnPinningFeature } from './column-pinning/columnPinningFeature'\nimport { columnResizingFeature } from './column-resizing/columnResizingFeature'\nimport { columnSizingFeature } from './column-sizing/columnSizingFeature'\nimport { columnVisibilityFeature } from './column-visibility/columnVisibilityFeature'\nimport { globalFilteringFeature } from './global-filtering/globalFilteringFeature'\nimport { rowExpandingFeature } from './row-expanding/rowExpandingFeature'\nimport { rowPaginationFeature } from './row-pagination/rowPaginationFeature'\nimport { rowPinningFeature } from './row-pinning/rowPinningFeature'\nimport { rowSelectionFeature } from './row-selection/rowSelectionFeature'\nimport { rowSortingFeature } from './row-sorting/rowSortingFeature'\n\nexport interface StockFeatures {\n  columnFacetingFeature: typeof columnFacetingFeature\n  columnFilteringFeature: typeof columnFilteringFeature\n  columnGroupingFeature: typeof columnGroupingFeature\n  columnOrderingFeature: typeof columnOrderingFeature\n  columnPinningFeature: typeof columnPinningFeature\n  columnResizingFeature: typeof columnResizingFeature\n  columnSizingFeature: typeof columnSizingFeature\n  columnVisibilityFeature: typeof columnVisibilityFeature\n  globalFilteringFeature: typeof globalFilteringFeature\n  rowExpandingFeature: typeof rowExpandingFeature\n  rowPaginationFeature: typeof rowPaginationFeature\n  rowPinningFeature: typeof rowPinningFeature\n  rowSelectionFeature: typeof rowSelectionFeature\n  rowSortingFeature: typeof rowSortingFeature\n}\n\n/**\n * The complete set of stock optional table features.\n *\n * Use individual feature exports for tree-shaking, or this aggregate when a table should include every built-in feature.\n */\nexport const stockFeatures: StockFeatures = {\n  columnFacetingFeature,\n  columnFilteringFeature,\n  columnGroupingFeature,\n  columnOrderingFeature,\n  columnPinningFeature,\n  columnResizingFeature,\n  columnSizingFeature,\n  columnVisibilityFeature,\n  globalFilteringFeature,\n  rowExpandingFeature,\n  rowPaginationFeature,\n  rowPinningFeature,\n  rowSelectionFeature,\n  rowSortingFeature,\n} as const\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAqCA,MAAa,gBAA+B;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD"}

package/dist/features/stockFeatures.d.cts

@@ -30,6 +30,11 @@ interface StockFeatures {
   rowSelectionFeature: typeof rowSelectionFeature;
   rowSortingFeature: typeof rowSortingFeature;
 }
+/**
+ * The complete set of stock optional table features.
+ *
+ * Use individual feature exports for tree-shaking, or this aggregate when a table should include every built-in feature.
+ */
 declare const stockFeatures: StockFeatures;
 //#endregion
 export { StockFeatures, stockFeatures };

package/dist/features/stockFeatures.d.ts

@@ -30,6 +30,11 @@ interface StockFeatures {
   rowSelectionFeature: typeof rowSelectionFeature;
   rowSortingFeature: typeof rowSortingFeature;
 }
+/**
+ * The complete set of stock optional table features.
+ *
+ * Use individual feature exports for tree-shaking, or this aggregate when a table should include every built-in feature.
+ */
 declare const stockFeatures: StockFeatures;
 //#endregion
 export { StockFeatures, stockFeatures };

package/dist/features/stockFeatures.js

@@ -14,6 +14,11 @@ import { rowSelectionFeature } from "./row-selection/rowSelectionFeature.js";
 import { rowSortingFeature } from "./row-sorting/rowSortingFeature.js";
 
 //#region src/features/stockFeatures.ts
+/**
+* The complete set of stock optional table features.
+*
+* Use individual feature exports for tree-shaking, or this aggregate when a table should include every built-in feature.
+*/
 const stockFeatures = {
 	columnFacetingFeature,
 	columnFilteringFeature,

package/dist/features/stockFeatures.js.map

@@ -1 +1 @@
-{"version":3,"file":"stockFeatures.js","names":[],"sources":["../../src/features/stockFeatures.ts"],"sourcesContent":["import { columnFacetingFeature } from './column-faceting/columnFacetingFeature'\nimport { columnFilteringFeature } from './column-filtering/columnFilteringFeature'\nimport { columnGroupingFeature } from './column-grouping/columnGroupingFeature'\nimport { columnOrderingFeature } from './column-ordering/columnOrderingFeature'\nimport { columnPinningFeature } from './column-pinning/columnPinningFeature'\nimport { columnResizingFeature } from './column-resizing/columnResizingFeature'\nimport { columnSizingFeature } from './column-sizing/columnSizingFeature'\nimport { columnVisibilityFeature } from './column-visibility/columnVisibilityFeature'\nimport { globalFilteringFeature } from './global-filtering/globalFilteringFeature'\nimport { rowExpandingFeature } from './row-expanding/rowExpandingFeature'\nimport { rowPaginationFeature } from './row-pagination/rowPaginationFeature'\nimport { rowPinningFeature } from './row-pinning/rowPinningFeature'\nimport { rowSelectionFeature } from './row-selection/rowSelectionFeature'\nimport { rowSortingFeature } from './row-sorting/rowSortingFeature'\n\nexport interface StockFeatures {\n  columnFacetingFeature: typeof columnFacetingFeature\n  columnFilteringFeature: typeof columnFilteringFeature\n  columnGroupingFeature: typeof columnGroupingFeature\n  columnOrderingFeature: typeof columnOrderingFeature\n  columnPinningFeature: typeof columnPinningFeature\n  columnResizingFeature: typeof columnResizingFeature\n  columnSizingFeature: typeof columnSizingFeature\n  columnVisibilityFeature: typeof columnVisibilityFeature\n  globalFilteringFeature: typeof globalFilteringFeature\n  rowExpandingFeature: typeof rowExpandingFeature\n  rowPaginationFeature: typeof rowPaginationFeature\n  rowPinningFeature: typeof rowPinningFeature\n  rowSelectionFeature: typeof rowSelectionFeature\n  rowSortingFeature: typeof rowSortingFeature\n}\n\nexport const stockFeatures: StockFeatures = {\n  columnFacetingFeature,\n  columnFilteringFeature,\n  columnGroupingFeature,\n  columnOrderingFeature,\n  columnPinningFeature,\n  columnResizingFeature,\n  columnSizingFeature,\n  columnVisibilityFeature,\n  globalFilteringFeature,\n  rowExpandingFeature,\n  rowPaginationFeature,\n  rowPinningFeature,\n  rowSelectionFeature,\n  rowSortingFeature,\n} as const\n"],"mappings":";;;;;;;;;;;;;;;;AAgCA,MAAa,gBAA+B;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD"}
+{"version":3,"file":"stockFeatures.js","names":[],"sources":["../../src/features/stockFeatures.ts"],"sourcesContent":["import { columnFacetingFeature } from './column-faceting/columnFacetingFeature'\nimport { columnFilteringFeature } from './column-filtering/columnFilteringFeature'\nimport { columnGroupingFeature } from './column-grouping/columnGroupingFeature'\nimport { columnOrderingFeature } from './column-ordering/columnOrderingFeature'\nimport { columnPinningFeature } from './column-pinning/columnPinningFeature'\nimport { columnResizingFeature } from './column-resizing/columnResizingFeature'\nimport { columnSizingFeature } from './column-sizing/columnSizingFeature'\nimport { columnVisibilityFeature } from './column-visibility/columnVisibilityFeature'\nimport { globalFilteringFeature } from './global-filtering/globalFilteringFeature'\nimport { rowExpandingFeature } from './row-expanding/rowExpandingFeature'\nimport { rowPaginationFeature } from './row-pagination/rowPaginationFeature'\nimport { rowPinningFeature } from './row-pinning/rowPinningFeature'\nimport { rowSelectionFeature } from './row-selection/rowSelectionFeature'\nimport { rowSortingFeature } from './row-sorting/rowSortingFeature'\n\nexport interface StockFeatures {\n  columnFacetingFeature: typeof columnFacetingFeature\n  columnFilteringFeature: typeof columnFilteringFeature\n  columnGroupingFeature: typeof columnGroupingFeature\n  columnOrderingFeature: typeof columnOrderingFeature\n  columnPinningFeature: typeof columnPinningFeature\n  columnResizingFeature: typeof columnResizingFeature\n  columnSizingFeature: typeof columnSizingFeature\n  columnVisibilityFeature: typeof columnVisibilityFeature\n  globalFilteringFeature: typeof globalFilteringFeature\n  rowExpandingFeature: typeof rowExpandingFeature\n  rowPaginationFeature: typeof rowPaginationFeature\n  rowPinningFeature: typeof rowPinningFeature\n  rowSelectionFeature: typeof rowSelectionFeature\n  rowSortingFeature: typeof rowSortingFeature\n}\n\n/**\n * The complete set of stock optional table features.\n *\n * Use individual feature exports for tree-shaking, or this aggregate when a table should include every built-in feature.\n */\nexport const stockFeatures: StockFeatures = {\n  columnFacetingFeature,\n  columnFilteringFeature,\n  columnGroupingFeature,\n  columnOrderingFeature,\n  columnPinningFeature,\n  columnResizingFeature,\n  columnSizingFeature,\n  columnVisibilityFeature,\n  globalFilteringFeature,\n  rowExpandingFeature,\n  rowPaginationFeature,\n  rowPinningFeature,\n  rowSelectionFeature,\n  rowSortingFeature,\n} as const\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAqCA,MAAa,gBAA+B;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD"}

package/dist/flex-render.cjs

@@ -1,11 +1,21 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 //#region src/flex-render.ts
+/**
+* Renders a static value or render function with the provided props.
+*
+* Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+*/
 function flexRender(comp, props) {
 	if (comp == null) return null;
 	if (typeof comp === "function") return comp(props);
 	return comp;
 }
+/**
+* Renders a static value or render function with the provided props.
+*
+* Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+*/
 function FlexRender(props) {
 	if ("cell" in props && props.cell) return flexRender(props.cell.column.columnDef.cell, props.cell.getContext());
 	if ("header" in props && props.header) return flexRender(props.header.column.columnDef.header, props.header.getContext());

package/dist/flex-render.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"flex-render.cjs","names":[],"sources":["../src/flex-render.ts"],"sourcesContent":["import type { Cell } from './types/Cell'\nimport type { Header } from './types/Header'\nimport type { TableFeatures } from './types/TableFeatures'\nimport type { CellData, RowData } from './types/type-utils'\n\nexport function flexRender<TProps extends object>(\n  comp: unknown,\n  props: TProps,\n): unknown | null {\n  if (comp == null) return null\n\n  if (typeof comp === 'function') {\n    return comp(props)\n  }\n\n  return comp\n}\n\nexport type FlexRenderProps<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n> =\n  | { cell: Cell<TFeatures, TData, TValue>; header?: never; footer?: never }\n  | {\n      header: Header<TFeatures, TData, TValue>\n      cell?: never\n      footer?: never\n    }\n  | {\n      footer: Header<TFeatures, TData, TValue>\n      cell?: never\n      header?: never\n    }\n\nexport function FlexRender<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(props: FlexRenderProps<TFeatures, TData, TValue>): unknown | null {\n  if ('cell' in props && props.cell) {\n    return flexRender(props.cell.column.columnDef.cell, props.cell.getContext())\n  }\n\n  if ('header' in props && props.header) {\n    return flexRender(\n      props.header.column.columnDef.header,\n      props.header.getContext(),\n    )\n  }\n\n  if ('footer' in props && props.footer) {\n    return flexRender(\n      props.footer.column.columnDef.footer,\n      props.footer.getContext(),\n    )\n  }\n\n  return null\n}\n"],"mappings":";;;AAKA,SAAgB,WACd,MACA,OACgB;AAChB,KAAI,QAAQ,KAAM,QAAO;AAEzB,KAAI,OAAO,SAAS,WAClB,QAAO,KAAK,MAAM;AAGpB,QAAO;;AAoBT,SAAgB,WAId,OAAkE;AAClE,KAAI,UAAU,SAAS,MAAM,KAC3B,QAAO,WAAW,MAAM,KAAK,OAAO,UAAU,MAAM,MAAM,KAAK,YAAY,CAAC;AAG9E,KAAI,YAAY,SAAS,MAAM,OAC7B,QAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;AAGH,KAAI,YAAY,SAAS,MAAM,OAC7B,QAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;AAGH,QAAO"}
+{"version":3,"file":"flex-render.cjs","names":[],"sources":["../src/flex-render.ts"],"sourcesContent":["import type { Cell } from './types/Cell'\nimport type { Header } from './types/Header'\nimport type { TableFeatures } from './types/TableFeatures'\nimport type { CellData, RowData } from './types/type-utils'\n\n/**\n * Renders a static value or render function with the provided props.\n *\n * Framework adapters use this helper to support column definitions that contain either plain values or template functions.\n */\nexport function flexRender<TProps extends object>(\n  comp: unknown,\n  props: TProps,\n): unknown | null {\n  if (comp == null) return null\n\n  if (typeof comp === 'function') {\n    return comp(props)\n  }\n\n  return comp\n}\n\nexport type FlexRenderProps<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n> =\n  | { cell: Cell<TFeatures, TData, TValue>; header?: never; footer?: never }\n  | {\n      header: Header<TFeatures, TData, TValue>\n      cell?: never\n      footer?: never\n    }\n  | {\n      footer: Header<TFeatures, TData, TValue>\n      cell?: never\n      header?: never\n    }\n\n/**\n * Renders a static value or render function with the provided props.\n *\n * Framework adapters use this helper to support column definitions that contain either plain values or template functions.\n */\nexport function FlexRender<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(props: FlexRenderProps<TFeatures, TData, TValue>): unknown | null {\n  if ('cell' in props && props.cell) {\n    return flexRender(props.cell.column.columnDef.cell, props.cell.getContext())\n  }\n\n  if ('header' in props && props.header) {\n    return flexRender(\n      props.header.column.columnDef.header,\n      props.header.getContext(),\n    )\n  }\n\n  if ('footer' in props && props.footer) {\n    return flexRender(\n      props.footer.column.columnDef.footer,\n      props.footer.getContext(),\n    )\n  }\n\n  return null\n}\n"],"mappings":";;;;;;;;AAUA,SAAgB,WACd,MACA,OACgB;CAChB,IAAI,QAAQ,MAAM,OAAO;CAEzB,IAAI,OAAO,SAAS,YAClB,OAAO,KAAK,MAAM;CAGpB,OAAO;;;;;;;AAyBT,SAAgB,WAId,OAAkE;CAClE,IAAI,UAAU,SAAS,MAAM,MAC3B,OAAO,WAAW,MAAM,KAAK,OAAO,UAAU,MAAM,MAAM,KAAK,YAAY,CAAC;CAG9E,IAAI,YAAY,SAAS,MAAM,QAC7B,OAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;CAGH,IAAI,YAAY,SAAS,MAAM,QAC7B,OAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;CAGH,OAAO"}

package/dist/flex-render.d.cts

@@ -4,6 +4,11 @@ import { TableFeatures } from "./types/TableFeatures.cjs";
 import { Cell } from "./types/Cell.cjs";
 
 //#region src/flex-render.d.ts
+/**
+ * Renders a static value or render function with the provided props.
+ *
+ * Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+ */
 declare function flexRender<TProps extends object>(comp: unknown, props: TProps): unknown | null;
 type FlexRenderProps<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> = {
   cell: Cell<TFeatures, TData, TValue>;
@@ -18,6 +23,11 @@ type FlexRenderProps<TFeatures extends TableFeatures, TData extends RowData, TVa
   cell?: never;
   header?: never;
 };
+/**
+ * Renders a static value or render function with the provided props.
+ *
+ * Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+ */
 declare function FlexRender<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(props: FlexRenderProps<TFeatures, TData, TValue>): unknown | null;
 //#endregion
 export { FlexRender, FlexRenderProps, flexRender };

package/dist/flex-render.d.ts

@@ -4,6 +4,11 @@ import { TableFeatures } from "./types/TableFeatures.js";
 import { Cell } from "./types/Cell.js";
 
 //#region src/flex-render.d.ts
+/**
+ * Renders a static value or render function with the provided props.
+ *
+ * Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+ */
 declare function flexRender<TProps extends object>(comp: unknown, props: TProps): unknown | null;
 type FlexRenderProps<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> = {
   cell: Cell<TFeatures, TData, TValue>;
@@ -18,6 +23,11 @@ type FlexRenderProps<TFeatures extends TableFeatures, TData extends RowData, TVa
   cell?: never;
   header?: never;
 };
+/**
+ * Renders a static value or render function with the provided props.
+ *
+ * Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+ */
 declare function FlexRender<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(props: FlexRenderProps<TFeatures, TData, TValue>): unknown | null;
 //#endregion
 export { FlexRender, FlexRenderProps, flexRender };

package/dist/flex-render.js

@@ -1,9 +1,19 @@
 //#region src/flex-render.ts
+/**
+* Renders a static value or render function with the provided props.
+*
+* Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+*/
 function flexRender(comp, props) {
 	if (comp == null) return null;
 	if (typeof comp === "function") return comp(props);
 	return comp;
 }
+/**
+* Renders a static value or render function with the provided props.
+*
+* Framework adapters use this helper to support column definitions that contain either plain values or template functions.
+*/
 function FlexRender(props) {
 	if ("cell" in props && props.cell) return flexRender(props.cell.column.columnDef.cell, props.cell.getContext());
 	if ("header" in props && props.header) return flexRender(props.header.column.columnDef.header, props.header.getContext());

package/dist/flex-render.js.map

@@ -1 +1 @@
-{"version":3,"file":"flex-render.js","names":[],"sources":["../src/flex-render.ts"],"sourcesContent":["import type { Cell } from './types/Cell'\nimport type { Header } from './types/Header'\nimport type { TableFeatures } from './types/TableFeatures'\nimport type { CellData, RowData } from './types/type-utils'\n\nexport function flexRender<TProps extends object>(\n  comp: unknown,\n  props: TProps,\n): unknown | null {\n  if (comp == null) return null\n\n  if (typeof comp === 'function') {\n    return comp(props)\n  }\n\n  return comp\n}\n\nexport type FlexRenderProps<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n> =\n  | { cell: Cell<TFeatures, TData, TValue>; header?: never; footer?: never }\n  | {\n      header: Header<TFeatures, TData, TValue>\n      cell?: never\n      footer?: never\n    }\n  | {\n      footer: Header<TFeatures, TData, TValue>\n      cell?: never\n      header?: never\n    }\n\nexport function FlexRender<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(props: FlexRenderProps<TFeatures, TData, TValue>): unknown | null {\n  if ('cell' in props && props.cell) {\n    return flexRender(props.cell.column.columnDef.cell, props.cell.getContext())\n  }\n\n  if ('header' in props && props.header) {\n    return flexRender(\n      props.header.column.columnDef.header,\n      props.header.getContext(),\n    )\n  }\n\n  if ('footer' in props && props.footer) {\n    return flexRender(\n      props.footer.column.columnDef.footer,\n      props.footer.getContext(),\n    )\n  }\n\n  return null\n}\n"],"mappings":";AAKA,SAAgB,WACd,MACA,OACgB;AAChB,KAAI,QAAQ,KAAM,QAAO;AAEzB,KAAI,OAAO,SAAS,WAClB,QAAO,KAAK,MAAM;AAGpB,QAAO;;AAoBT,SAAgB,WAId,OAAkE;AAClE,KAAI,UAAU,SAAS,MAAM,KAC3B,QAAO,WAAW,MAAM,KAAK,OAAO,UAAU,MAAM,MAAM,KAAK,YAAY,CAAC;AAG9E,KAAI,YAAY,SAAS,MAAM,OAC7B,QAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;AAGH,KAAI,YAAY,SAAS,MAAM,OAC7B,QAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;AAGH,QAAO"}
+{"version":3,"file":"flex-render.js","names":[],"sources":["../src/flex-render.ts"],"sourcesContent":["import type { Cell } from './types/Cell'\nimport type { Header } from './types/Header'\nimport type { TableFeatures } from './types/TableFeatures'\nimport type { CellData, RowData } from './types/type-utils'\n\n/**\n * Renders a static value or render function with the provided props.\n *\n * Framework adapters use this helper to support column definitions that contain either plain values or template functions.\n */\nexport function flexRender<TProps extends object>(\n  comp: unknown,\n  props: TProps,\n): unknown | null {\n  if (comp == null) return null\n\n  if (typeof comp === 'function') {\n    return comp(props)\n  }\n\n  return comp\n}\n\nexport type FlexRenderProps<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n> =\n  | { cell: Cell<TFeatures, TData, TValue>; header?: never; footer?: never }\n  | {\n      header: Header<TFeatures, TData, TValue>\n      cell?: never\n      footer?: never\n    }\n  | {\n      footer: Header<TFeatures, TData, TValue>\n      cell?: never\n      header?: never\n    }\n\n/**\n * Renders a static value or render function with the provided props.\n *\n * Framework adapters use this helper to support column definitions that contain either plain values or template functions.\n */\nexport function FlexRender<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(props: FlexRenderProps<TFeatures, TData, TValue>): unknown | null {\n  if ('cell' in props && props.cell) {\n    return flexRender(props.cell.column.columnDef.cell, props.cell.getContext())\n  }\n\n  if ('header' in props && props.header) {\n    return flexRender(\n      props.header.column.columnDef.header,\n      props.header.getContext(),\n    )\n  }\n\n  if ('footer' in props && props.footer) {\n    return flexRender(\n      props.footer.column.columnDef.footer,\n      props.footer.getContext(),\n    )\n  }\n\n  return null\n}\n"],"mappings":";;;;;;AAUA,SAAgB,WACd,MACA,OACgB;CAChB,IAAI,QAAQ,MAAM,OAAO;CAEzB,IAAI,OAAO,SAAS,YAClB,OAAO,KAAK,MAAM;CAGpB,OAAO;;;;;;;AAyBT,SAAgB,WAId,OAAkE;CAClE,IAAI,UAAU,SAAS,MAAM,MAC3B,OAAO,WAAW,MAAM,KAAK,OAAO,UAAU,MAAM,MAAM,KAAK,YAAY,CAAC;CAG9E,IAAI,YAAY,SAAS,MAAM,QAC7B,OAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;CAGH,IAAI,YAAY,SAAS,MAAM,QAC7B,OAAO,WACL,MAAM,OAAO,OAAO,UAAU,QAC9B,MAAM,OAAO,YAAY,CAC1B;CAGH,OAAO"}

package/dist/fns/aggregationFns.cjs

@@ -99,6 +99,11 @@ const aggregationFn_uniqueCount = (columnId, leafRows) => {
 const aggregationFn_count = (_columnId, leafRows) => {
 	return leafRows.length;
 };
+/**
+* The built-in aggregation function registry.
+*
+* Pass this object to grouped row model creation or extend it with custom aggregation functions for grouped columns.
+*/
 const aggregationFns = {
 	sum: aggregationFn_sum,
 	min: aggregationFn_min,

package/dist/fns/aggregationFns.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"aggregationFns.cjs","names":["isNumberArray"],"sources":["../../src/fns/aggregationFns.ts"],"sourcesContent":["import { isNumberArray } from '../utils'\nimport type { RowData } from '../types/type-utils'\nimport type { TableFeatures } from '../types/TableFeatures'\nimport type { Row } from '../types/Row'\nimport type { AggregationFn } from '../features/column-grouping/columnGroupingFeature.types'\n\n/**\n * Aggregation function for summing up the values of a column.\n */\nexport const aggregationFn_sum: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  // It's faster to just add the aggregations together instead of\n  // process leaf nodes individually\n  return childRows.reduce((sumValue, next) => {\n    const nextValue = next.getValue(columnId)\n    return sumValue + (typeof nextValue === 'number' ? nextValue : 0)\n  }, 0)\n}\n\n/**\n * Aggregation function for finding the minimum value of a column.\n */\nexport const aggregationFn_min: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  let minValue: number | undefined\n\n  childRows.forEach((row) => {\n    const value = row.getValue(columnId)\n\n    if (\n      value != null &&\n      typeof value === 'number' &&\n      (minValue === undefined || value < minValue)\n    ) {\n      minValue = value\n    }\n  })\n\n  return minValue\n}\n\n/**\n * Aggregation function for finding the maximum value of a column.\n */\nexport const aggregationFn_max: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  let maxValue: number | undefined\n\n  childRows.forEach((row) => {\n    const value = row.getValue(columnId)\n    if (\n      value != null &&\n      typeof value === 'number' &&\n      (maxValue === undefined || value > maxValue)\n    ) {\n      maxValue = value\n    }\n  })\n\n  return maxValue\n}\n\n/**\n * Aggregation function for finding the extent (min and max) of a column.\n */\nexport const aggregationFn_extent: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  let minValue: number | undefined\n  let maxValue: number | undefined\n\n  childRows.forEach((row) => {\n    const value = row.getValue(columnId)\n    if (value != null && typeof value === 'number') {\n      if (minValue === undefined) {\n        minValue = maxValue = value\n      } else {\n        if (minValue > value) minValue = value\n        if (maxValue! < value) maxValue = value\n      }\n    }\n  })\n\n  return [minValue, maxValue]\n}\n\n/**\n * Aggregation function for finding the mean (average) of a column.\n */\nexport const aggregationFn_mean: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  let count = 0\n  let sumValue = 0\n\n  leafRows.forEach((row) => {\n    const value = row.getValue(columnId)\n    if (value != null && typeof value === 'number') {\n      ++count\n      sumValue += value\n    } else if (value != null) {\n      const numValue = +value\n      if (!Number.isNaN(numValue)) {\n        ++count\n        sumValue += numValue\n      }\n    }\n  })\n\n  if (count) return sumValue / count\n\n  return\n}\n\n/**\n * Aggregation function for finding the median value of a column.\n */\nexport const aggregationFn_median: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  if (!leafRows.length) {\n    return\n  }\n\n  const values = leafRows.map((row) => row.getValue(columnId))\n  if (!isNumberArray(values)) {\n    return\n  }\n  if (values.length === 1) {\n    return values[0]\n  }\n\n  const mid = Math.floor(values.length / 2)\n  const nums = values.sort((a, b) => a - b)\n  return values.length % 2 !== 0 ? nums[mid] : (nums[mid - 1]! + nums[mid]!) / 2\n}\n\n/**\n * Aggregation function for finding the unique values of a column.\n */\nexport const aggregationFn_unique: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  return Array.from(new Set(leafRows.map((d) => d.getValue(columnId))).values())\n}\n\n/**\n * Aggregation function for finding the count of unique values of a column.\n */\nexport const aggregationFn_uniqueCount: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  return new Set(leafRows.map((d) => d.getValue(columnId))).size\n}\n\n/**\n * Aggregation function for counting the number of rows in a column.\n */\nexport const aggregationFn_count: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  _columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  return leafRows.length\n}\n\nexport const aggregationFns = {\n  sum: aggregationFn_sum,\n  min: aggregationFn_min,\n  max: aggregationFn_max,\n  extent: aggregationFn_extent,\n  mean: aggregationFn_mean,\n  median: aggregationFn_median,\n  unique: aggregationFn_unique,\n  uniqueCount: aggregationFn_uniqueCount,\n  count: aggregationFn_count,\n}\n\nexport type BuiltInAggregationFn = keyof typeof aggregationFns\n"],"mappings":";;;;;;AASA,MAAa,qBAIX,UACA,WACA,cACG;AAGH,QAAO,UAAU,QAAQ,UAAU,SAAS;EAC1C,MAAM,YAAY,KAAK,SAAS,SAAS;AACzC,SAAO,YAAY,OAAO,cAAc,WAAW,YAAY;IAC9D,EAAE;;;;;AAMP,MAAa,qBAIX,UACA,WACA,cACG;CACH,IAAI;AAEJ,WAAU,SAAS,QAAQ;EACzB,MAAM,QAAQ,IAAI,SAAS,SAAS;AAEpC,MACE,SAAS,QACT,OAAO,UAAU,aAChB,aAAa,UAAa,QAAQ,UAEnC,YAAW;GAEb;AAEF,QAAO;;;;;AAMT,MAAa,qBAIX,UACA,WACA,cACG;CACH,IAAI;AAEJ,WAAU,SAAS,QAAQ;EACzB,MAAM,QAAQ,IAAI,SAAS,SAAS;AACpC,MACE,SAAS,QACT,OAAO,UAAU,aAChB,aAAa,UAAa,QAAQ,UAEnC,YAAW;GAEb;AAEF,QAAO;;;;;AAMT,MAAa,wBAIX,UACA,WACA,cACG;CACH,IAAI;CACJ,IAAI;AAEJ,WAAU,SAAS,QAAQ;EACzB,MAAM,QAAQ,IAAI,SAAS,SAAS;AACpC,MAAI,SAAS,QAAQ,OAAO,UAAU,SACpC,KAAI,aAAa,OACf,YAAW,WAAW;OACjB;AACL,OAAI,WAAW,MAAO,YAAW;AACjC,OAAI,WAAY,MAAO,YAAW;;GAGtC;AAEF,QAAO,CAAC,UAAU,SAAS;;;;;AAM7B,MAAa,sBAIX,UACA,aACG;CACH,IAAI,QAAQ;CACZ,IAAI,WAAW;AAEf,UAAS,SAAS,QAAQ;EACxB,MAAM,QAAQ,IAAI,SAAS,SAAS;AACpC,MAAI,SAAS,QAAQ,OAAO,UAAU,UAAU;AAC9C,KAAE;AACF,eAAY;aACH,SAAS,MAAM;GACxB,MAAM,WAAW,CAAC;AAClB,OAAI,CAAC,OAAO,MAAM,SAAS,EAAE;AAC3B,MAAE;AACF,gBAAY;;;GAGhB;AAEF,KAAI,MAAO,QAAO,WAAW;;;;;AAQ/B,MAAa,wBAIX,UACA,aACG;AACH,KAAI,CAAC,SAAS,OACZ;CAGF,MAAM,SAAS,SAAS,KAAK,QAAQ,IAAI,SAAS,SAAS,CAAC;AAC5D,KAAI,CAACA,4BAAc,OAAO,CACxB;AAEF,KAAI,OAAO,WAAW,EACpB,QAAO,OAAO;CAGhB,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,EAAE;CACzC,MAAM,OAAO,OAAO,MAAM,GAAG,MAAM,IAAI,EAAE;AACzC,QAAO,OAAO,SAAS,MAAM,IAAI,KAAK,QAAQ,KAAK,MAAM,KAAM,KAAK,QAAS;;;;;AAM/E,MAAa,wBAIX,UACA,aACG;AACH,QAAO,MAAM,KAAK,IAAI,IAAI,SAAS,KAAK,MAAM,EAAE,SAAS,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;;;;;AAMhF,MAAa,6BAIX,UACA,aACG;AACH,QAAO,IAAI,IAAI,SAAS,KAAK,MAAM,EAAE,SAAS,SAAS,CAAC,CAAC,CAAC;;;;;AAM5D,MAAa,uBAIX,WACA,aACG;AACH,QAAO,SAAS;;AAGlB,MAAa,iBAAiB;CAC5B,KAAK;CACL,KAAK;CACL,KAAK;CACL,QAAQ;CACR,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,aAAa;CACb,OAAO;CACR"}
+{"version":3,"file":"aggregationFns.cjs","names":["isNumberArray"],"sources":["../../src/fns/aggregationFns.ts"],"sourcesContent":["import { isNumberArray } from '../utils'\nimport type { RowData } from '../types/type-utils'\nimport type { TableFeatures } from '../types/TableFeatures'\nimport type { Row } from '../types/Row'\nimport type { AggregationFn } from '../features/column-grouping/columnGroupingFeature.types'\n\n/**\n * Aggregation function for summing up the values of a column.\n */\nexport const aggregationFn_sum: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  // It's faster to just add the aggregations together instead of\n  // process leaf nodes individually\n  return childRows.reduce((sumValue, next) => {\n    const nextValue = next.getValue(columnId)\n    return sumValue + (typeof nextValue === 'number' ? nextValue : 0)\n  }, 0)\n}\n\n/**\n * Aggregation function for finding the minimum value of a column.\n */\nexport const aggregationFn_min: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  let minValue: number | undefined\n\n  childRows.forEach((row) => {\n    const value = row.getValue(columnId)\n\n    if (\n      value != null &&\n      typeof value === 'number' &&\n      (minValue === undefined || value < minValue)\n    ) {\n      minValue = value\n    }\n  })\n\n  return minValue\n}\n\n/**\n * Aggregation function for finding the maximum value of a column.\n */\nexport const aggregationFn_max: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  let maxValue: number | undefined\n\n  childRows.forEach((row) => {\n    const value = row.getValue(columnId)\n    if (\n      value != null &&\n      typeof value === 'number' &&\n      (maxValue === undefined || value > maxValue)\n    ) {\n      maxValue = value\n    }\n  })\n\n  return maxValue\n}\n\n/**\n * Aggregation function for finding the extent (min and max) of a column.\n */\nexport const aggregationFn_extent: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  _leafRows: Array<Row<any, any>>,\n  childRows: Array<Row<any, any>>,\n) => {\n  let minValue: number | undefined\n  let maxValue: number | undefined\n\n  childRows.forEach((row) => {\n    const value = row.getValue(columnId)\n    if (value != null && typeof value === 'number') {\n      if (minValue === undefined) {\n        minValue = maxValue = value\n      } else {\n        if (minValue > value) minValue = value\n        if (maxValue! < value) maxValue = value\n      }\n    }\n  })\n\n  return [minValue, maxValue]\n}\n\n/**\n * Aggregation function for finding the mean (average) of a column.\n */\nexport const aggregationFn_mean: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  let count = 0\n  let sumValue = 0\n\n  leafRows.forEach((row) => {\n    const value = row.getValue(columnId)\n    if (value != null && typeof value === 'number') {\n      ++count\n      sumValue += value\n    } else if (value != null) {\n      const numValue = +value\n      if (!Number.isNaN(numValue)) {\n        ++count\n        sumValue += numValue\n      }\n    }\n  })\n\n  if (count) return sumValue / count\n\n  return\n}\n\n/**\n * Aggregation function for finding the median value of a column.\n */\nexport const aggregationFn_median: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  if (!leafRows.length) {\n    return\n  }\n\n  const values = leafRows.map((row) => row.getValue(columnId))\n  if (!isNumberArray(values)) {\n    return\n  }\n  if (values.length === 1) {\n    return values[0]\n  }\n\n  const mid = Math.floor(values.length / 2)\n  const nums = values.sort((a, b) => a - b)\n  return values.length % 2 !== 0 ? nums[mid] : (nums[mid - 1]! + nums[mid]!) / 2\n}\n\n/**\n * Aggregation function for finding the unique values of a column.\n */\nexport const aggregationFn_unique: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  return Array.from(new Set(leafRows.map((d) => d.getValue(columnId))).values())\n}\n\n/**\n * Aggregation function for finding the count of unique values of a column.\n */\nexport const aggregationFn_uniqueCount: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  return new Set(leafRows.map((d) => d.getValue(columnId))).size\n}\n\n/**\n * Aggregation function for counting the number of rows in a column.\n */\nexport const aggregationFn_count: AggregationFn<any, any> = <\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  _columnId: string,\n  leafRows: Array<Row<any, any>>,\n) => {\n  return leafRows.length\n}\n\n/**\n * The built-in aggregation function registry.\n *\n * Pass this object to grouped row model creation or extend it with custom aggregation functions for grouped columns.\n */\nexport const aggregationFns = {\n  sum: aggregationFn_sum,\n  min: aggregationFn_min,\n  max: aggregationFn_max,\n  extent: aggregationFn_extent,\n  mean: aggregationFn_mean,\n  median: aggregationFn_median,\n  unique: aggregationFn_unique,\n  uniqueCount: aggregationFn_uniqueCount,\n  count: aggregationFn_count,\n}\n\nexport type BuiltInAggregationFn = keyof typeof aggregationFns\n"],"mappings":";;;;;;AASA,MAAa,qBAIX,UACA,WACA,cACG;CAGH,OAAO,UAAU,QAAQ,UAAU,SAAS;EAC1C,MAAM,YAAY,KAAK,SAAS,SAAS;EACzC,OAAO,YAAY,OAAO,cAAc,WAAW,YAAY;IAC9D,EAAE;;;;;AAMP,MAAa,qBAIX,UACA,WACA,cACG;CACH,IAAI;CAEJ,UAAU,SAAS,QAAQ;EACzB,MAAM,QAAQ,IAAI,SAAS,SAAS;EAEpC,IACE,SAAS,QACT,OAAO,UAAU,aAChB,aAAa,UAAa,QAAQ,WAEnC,WAAW;GAEb;CAEF,OAAO;;;;;AAMT,MAAa,qBAIX,UACA,WACA,cACG;CACH,IAAI;CAEJ,UAAU,SAAS,QAAQ;EACzB,MAAM,QAAQ,IAAI,SAAS,SAAS;EACpC,IACE,SAAS,QACT,OAAO,UAAU,aAChB,aAAa,UAAa,QAAQ,WAEnC,WAAW;GAEb;CAEF,OAAO;;;;;AAMT,MAAa,wBAIX,UACA,WACA,cACG;CACH,IAAI;CACJ,IAAI;CAEJ,UAAU,SAAS,QAAQ;EACzB,MAAM,QAAQ,IAAI,SAAS,SAAS;EACpC,IAAI,SAAS,QAAQ,OAAO,UAAU,UACpC,IAAI,aAAa,QACf,WAAW,WAAW;OACjB;GACL,IAAI,WAAW,OAAO,WAAW;GACjC,IAAI,WAAY,OAAO,WAAW;;GAGtC;CAEF,OAAO,CAAC,UAAU,SAAS;;;;;AAM7B,MAAa,sBAIX,UACA,aACG;CACH,IAAI,QAAQ;CACZ,IAAI,WAAW;CAEf,SAAS,SAAS,QAAQ;EACxB,MAAM,QAAQ,IAAI,SAAS,SAAS;EACpC,IAAI,SAAS,QAAQ,OAAO,UAAU,UAAU;GAC9C,EAAE;GACF,YAAY;SACP,IAAI,SAAS,MAAM;GACxB,MAAM,WAAW,CAAC;GAClB,IAAI,CAAC,OAAO,MAAM,SAAS,EAAE;IAC3B,EAAE;IACF,YAAY;;;GAGhB;CAEF,IAAI,OAAO,OAAO,WAAW;;;;;AAQ/B,MAAa,wBAIX,UACA,aACG;CACH,IAAI,CAAC,SAAS,QACZ;CAGF,MAAM,SAAS,SAAS,KAAK,QAAQ,IAAI,SAAS,SAAS,CAAC;CAC5D,IAAI,CAACA,4BAAc,OAAO,EACxB;CAEF,IAAI,OAAO,WAAW,GACpB,OAAO,OAAO;CAGhB,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,EAAE;CACzC,MAAM,OAAO,OAAO,MAAM,GAAG,MAAM,IAAI,EAAE;CACzC,OAAO,OAAO,SAAS,MAAM,IAAI,KAAK,QAAQ,KAAK,MAAM,KAAM,KAAK,QAAS;;;;;AAM/E,MAAa,wBAIX,UACA,aACG;CACH,OAAO,MAAM,KAAK,IAAI,IAAI,SAAS,KAAK,MAAM,EAAE,SAAS,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;;;;;AAMhF,MAAa,6BAIX,UACA,aACG;CACH,OAAO,IAAI,IAAI,SAAS,KAAK,MAAM,EAAE,SAAS,SAAS,CAAC,CAAC,CAAC;;;;;AAM5D,MAAa,uBAIX,WACA,aACG;CACH,OAAO,SAAS;;;;;;;AAQlB,MAAa,iBAAiB;CAC5B,KAAK;CACL,KAAK;CACL,KAAK;CACL,QAAQ;CACR,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,aAAa;CACb,OAAO;CACR"}

package/dist/fns/aggregationFns.d.cts

@@ -37,6 +37,11 @@ declare const aggregationFn_uniqueCount: AggregationFn<any, any>;
  * Aggregation function for counting the number of rows in a column.
  */
 declare const aggregationFn_count: AggregationFn<any, any>;
+/**
+ * The built-in aggregation function registry.
+ *
+ * Pass this object to grouped row model creation or extend it with custom aggregation functions for grouped columns.
+ */
 declare const aggregationFns: {
   sum: AggregationFn<any, any>;
   min: AggregationFn<any, any>;

package/dist/fns/aggregationFns.d.ts

@@ -37,6 +37,11 @@ declare const aggregationFn_uniqueCount: AggregationFn<any, any>;
  * Aggregation function for counting the number of rows in a column.
  */
 declare const aggregationFn_count: AggregationFn<any, any>;
+/**
+ * The built-in aggregation function registry.
+ *
+ * Pass this object to grouped row model creation or extend it with custom aggregation functions for grouped columns.
+ */
 declare const aggregationFns: {
   sum: AggregationFn<any, any>;
   min: AggregationFn<any, any>;

package/dist/fns/aggregationFns.js

@@ -99,6 +99,11 @@ const aggregationFn_uniqueCount = (columnId, leafRows) => {
 const aggregationFn_count = (_columnId, leafRows) => {
 	return leafRows.length;
 };
+/**
+* The built-in aggregation function registry.
+*
+* Pass this object to grouped row model creation or extend it with custom aggregation functions for grouped columns.
+*/
 const aggregationFns = {
 	sum: aggregationFn_sum,
 	min: aggregationFn_min,