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

package/dist/features/row-expanding/rowExpandingFeature.utils.cjs

@@ -1,26 +1,97 @@
 const require_utils = require('../../utils.cjs');
 
 //#region src/features/row-expanding/rowExpandingFeature.utils.ts
+/**
+* Returns the default expanded state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultExpandedState()
+* ```
+*/
 function getDefaultExpandedState() {
 	return {};
 }
+/**
+* Schedules an automatic reset for expanded.
+*
+* The reset only runs when the related feature options allow automatic resets for the current table state change.
+*
+* @example
+* ```ts
+* table_autoResetExpanded(table)
+* ```
+*/
 function table_autoResetExpanded(table) {
 	if (table.options.autoResetAll ?? table.options.autoResetExpanded ?? !table.options.manualExpanding) queueMicrotask(() => table_resetExpanded(table));
 }
+/**
+* Updates the table's expanded state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setExpanded(table, (old) => old)
+* ```
+*/
 function table_setExpanded(table, updater) {
 	var _table$options$onExpa, _table$options;
 	(_table$options$onExpa = (_table$options = table.options).onExpandedChange) === null || _table$options$onExpa === void 0 || _table$options$onExpa.call(_table$options, updater);
 }
+/**
+* Toggles all rows expanded for the table.
+*
+* This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+*
+* @example
+* ```ts
+* table_toggleAllRowsExpanded(table)
+* ```
+*/
 function table_toggleAllRowsExpanded(table, expanded) {
 	if (expanded ?? !table_getIsAllRowsExpanded(table)) table_setExpanded(table, true);
 	else table_setExpanded(table, {});
 }
+/**
+* Resets the table's expanded state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetExpanded(table)
+* table_resetExpanded(table, true)
+* ```
+*/
 function table_resetExpanded(table, defaultState) {
 	table_setExpanded(table, defaultState ? {} : require_utils.cloneState(table.initialState.expanded ?? {}));
 }
+/**
+* Returns can some rows expand for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getCanSomeRowsExpand(table)
+* ```
+*/
 function table_getCanSomeRowsExpand(table) {
 	return table.getPrePaginatedRowModel().flatRows.some((row) => row_getCanExpand(row));
 }
+/**
+* Returns an event handler for all rows expanded handler.
+*
+* The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+*
+* @example
+* ```ts
+* const value = table_getToggleAllRowsExpandedHandler(table)
+* ```
+*/
 function table_getToggleAllRowsExpandedHandler(table) {
 	return (e) => {
 		var _persist;
@@ -28,11 +99,31 @@ function table_getToggleAllRowsExpandedHandler(table) {
 		table_toggleAllRowsExpanded(table);
 	};
 }
+/**
+* Returns is some rows expanded for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsSomeRowsExpanded(table)
+* ```
+*/
 function table_getIsSomeRowsExpanded(table) {
 	var _table$atoms$expanded;
 	const expanded = ((_table$atoms$expanded = table.atoms.expanded) === null || _table$atoms$expanded === void 0 ? void 0 : _table$atoms$expanded.get()) ?? {};
 	return expanded === true || Object.values(expanded).some(Boolean);
 }
+/**
+* Returns is all rows expanded for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsAllRowsExpanded(table)
+* ```
+*/
 function table_getIsAllRowsExpanded(table) {
 	var _table$atoms$expanded2;
 	const expanded = ((_table$atoms$expanded2 = table.atoms.expanded) === null || _table$atoms$expanded2 === void 0 ? void 0 : _table$atoms$expanded2.get()) ?? {};
@@ -41,6 +132,16 @@ function table_getIsAllRowsExpanded(table) {
 	if (table.getRowModel().flatRows.some((row) => !row_getIsExpanded(row))) return false;
 	return true;
 }
+/**
+* Returns expanded depth for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getExpandedDepth(table)
+* ```
+*/
 function table_getExpandedDepth(table) {
 	var _table$atoms$expanded3, _table$atoms$expanded4;
 	let maxDepth = 0;
@@ -50,6 +151,16 @@ function table_getExpandedDepth(table) {
 	});
 	return maxDepth;
 }
+/**
+* Toggles expanded for a row.
+*
+* The update is routed through the table state updater for the owning feature state slice.
+*
+* @example
+* ```ts
+* row_toggleExpanded(row)
+* ```
+*/
 function row_toggleExpanded(row, expanded) {
 	table_setExpanded(row.table, (old) => {
 		const exists = old === true ? true : !!old[row.id];
@@ -70,15 +181,45 @@ function row_toggleExpanded(row, expanded) {
 		return old;
 	});
 }
+/**
+* Returns is expanded for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsExpanded(row)
+* ```
+*/
 function row_getIsExpanded(row) {
 	var _row$table$atoms$expa, _row$table$options$ge, _row$table$options;
 	const expanded = ((_row$table$atoms$expa = row.table.atoms.expanded) === null || _row$table$atoms$expa === void 0 ? void 0 : _row$table$atoms$expa.get()) ?? {};
 	return !!(((_row$table$options$ge = (_row$table$options = row.table.options).getIsRowExpanded) === null || _row$table$options$ge === void 0 ? void 0 : _row$table$options$ge.call(_row$table$options, row)) ?? (expanded === true || expanded[row.id]));
 }
+/**
+* Returns whether a row can use expand.
+*
+* This evaluates row data, table options, and feature-specific enablement rules.
+*
+* @example
+* ```ts
+* const value = row_getCanExpand(row)
+* ```
+*/
 function row_getCanExpand(row) {
 	var _row$table$options$ge2, _row$table$options2;
 	return ((_row$table$options$ge2 = (_row$table$options2 = row.table.options).getRowCanExpand) === null || _row$table$options$ge2 === void 0 ? void 0 : _row$table$options$ge2.call(_row$table$options2, row)) ?? ((row.table.options.enableExpanding ?? true) && !!row.subRows.length);
 }
+/**
+* Returns is all parents expanded for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsAllParentsExpanded(row)
+* ```
+*/
 function row_getIsAllParentsExpanded(row) {
 	let isFullyExpanded = true;
 	let currentRow = row;
@@ -88,6 +229,16 @@ function row_getIsAllParentsExpanded(row) {
 	}
 	return isFullyExpanded;
 }
+/**
+* Returns an event handler for toggling expanded handler.
+*
+* The handler is intended for direct use in row-level controls such as expansion or selection buttons.
+*
+* @example
+* ```ts
+* const value = row_getToggleExpandedHandler(row)
+* ```
+*/
 function row_getToggleExpandedHandler(row) {
 	const canExpand = row_getCanExpand(row);
 	return () => {

package/dist/features/row-expanding/rowExpandingFeature.utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"rowExpandingFeature.utils.cjs","names":["cloneState"],"sources":["../../../src/features/row-expanding/rowExpandingFeature.utils.ts"],"sourcesContent":["import { cloneState } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type {\n  ExpandedState,\n  ExpandedStateList,\n} from './rowExpandingFeature.types'\n\nexport function getDefaultExpandedState(): ExpandedState {\n  return {}\n}\n\nexport function table_autoResetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  if (\n    table.options.autoResetAll ??\n    table.options.autoResetExpanded ??\n    !table.options.manualExpanding\n  ) {\n    queueMicrotask(() => table_resetExpanded(table))\n  }\n}\n\nexport function table_setExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<ExpandedState>) {\n  table.options.onExpandedChange?.(updater)\n}\n\nexport function table_toggleAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, expanded?: boolean) {\n  if (expanded ?? !table_getIsAllRowsExpanded(table)) {\n    table_setExpanded(table, true)\n  } else {\n    table_setExpanded(table, {})\n  }\n}\n\nexport function table_resetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setExpanded(\n    table,\n    defaultState ? {} : cloneState(table.initialState.expanded ?? {}),\n  )\n}\n\nexport function table_getCanSomeRowsExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getPrePaginatedRowModel()\n    .flatRows.some((row) => row_getCanExpand(row))\n}\n\nexport function table_getToggleAllRowsExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (e: unknown) => {\n    ;(e as any).persist?.()\n    table_toggleAllRowsExpanded(table)\n  }\n}\n\nexport function table_getIsSomeRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n  return expanded === true || Object.values(expanded).some(Boolean)\n}\n\nexport function table_getIsAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n\n  // If expanded is true, save some cycles and return true\n  if (expanded === true) {\n    return true\n  }\n\n  if (!Object.keys(expanded).length) {\n    return false\n  }\n\n  // If any row is not expanded, return false\n  if (table.getRowModel().flatRows.some((row) => !row_getIsExpanded(row))) {\n    return false\n  }\n\n  // They must all be expanded :shrug:\n  return true\n}\n\nexport function table_getExpandedDepth<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  let maxDepth = 0\n\n  const rowIds =\n    table.atoms.expanded?.get() === true\n      ? Object.keys(table.getRowModel().rowsById)\n      : Object.keys(table.atoms.expanded?.get() ?? {})\n\n  rowIds.forEach((id) => {\n    const splitId = id.split('.')\n    maxDepth = Math.max(maxDepth, splitId.length)\n  })\n\n  return maxDepth\n}\n\nexport function row_toggleExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>, expanded?: boolean) {\n  table_setExpanded(row.table, (old) => {\n    const exists = old === true ? true : !!old[row.id]\n\n    let oldExpanded: ExpandedStateList = {}\n\n    if (old === true) {\n      Object.keys(row.table.getRowModel().rowsById).forEach((rowId) => {\n        oldExpanded[rowId] = true\n      })\n    } else {\n      oldExpanded = old\n    }\n\n    expanded = expanded ?? !exists\n\n    if (!exists && expanded) {\n      return {\n        ...oldExpanded,\n        [row.id]: true,\n      }\n    }\n\n    if (exists && !expanded) {\n      const { [row.id]: _, ...rest } = oldExpanded\n      return rest\n    }\n\n    return old\n  })\n}\n\nexport function row_getIsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const expanded: ExpandedState = row.table.atoms.expanded?.get() ?? {}\n\n  return !!(\n    row.table.options.getIsRowExpanded?.(row) ??\n    (expanded === true || expanded[row.id])\n  )\n}\n\nexport function row_getCanExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  return (\n    row.table.options.getRowCanExpand?.(row) ??\n    ((row.table.options.enableExpanding ?? true) && !!row.subRows.length)\n  )\n}\n\nexport function row_getIsAllParentsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  let isFullyExpanded = true\n  let currentRow = row\n\n  while (isFullyExpanded && currentRow.parentId) {\n    currentRow = row.table.getRow(currentRow.parentId, true)\n    isFullyExpanded = row_getIsExpanded(row)\n  }\n\n  return isFullyExpanded\n}\n\nexport function row_getToggleExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const canExpand = row_getCanExpand(row)\n\n  return () => {\n    if (!canExpand) return\n    row_toggleExpanded(row)\n  }\n}\n"],"mappings":";;;AAUA,SAAgB,0BAAyC;AACvD,QAAO,EAAE;;AAGX,SAAgB,wBAGd,OAAyC;AACzC,KACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,qBACd,CAAC,MAAM,QAAQ,gBAEf,sBAAqB,oBAAoB,MAAM,CAAC;;AAIpD,SAAgB,kBAGd,OAAyC,SAAiC;;AAC1E,kDAAM,SAAQ,6GAAmB,QAAQ;;AAG3C,SAAgB,4BAGd,OAAyC,UAAoB;AAC7D,KAAI,YAAY,CAAC,2BAA2B,MAAM,CAChD,mBAAkB,OAAO,KAAK;KAE9B,mBAAkB,OAAO,EAAE,CAAC;;AAIhC,SAAgB,oBAGd,OAAyC,cAAwB;AACjE,mBACE,OACA,eAAe,EAAE,GAAGA,yBAAW,MAAM,aAAa,YAAY,EAAE,CAAC,CAClE;;AAGH,SAAgB,2BAGd,OAAyC;AACzC,QAAO,MACJ,yBAAyB,CACzB,SAAS,MAAM,QAAQ,iBAAiB,IAAI,CAAC;;AAGlD,SAAgB,sCAGd,OAAyC;AACzC,SAAQ,MAAe;;AACpB,cAAC,EAAU,4DAAW;AACvB,8BAA4B,MAAM;;;AAItC,SAAgB,4BAGd,OAAyC;;CACzC,MAAM,qCAAW,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;AAClD,QAAO,aAAa,QAAQ,OAAO,OAAO,SAAS,CAAC,KAAK,QAAQ;;AAGnE,SAAgB,2BAGd,OAAyC;;CACzC,MAAM,sCAAW,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE;AAGlD,KAAI,aAAa,KACf,QAAO;AAGT,KAAI,CAAC,OAAO,KAAK,SAAS,CAAC,OACzB,QAAO;AAIT,KAAI,MAAM,aAAa,CAAC,SAAS,MAAM,QAAQ,CAAC,kBAAkB,IAAI,CAAC,CACrE,QAAO;AAIT,QAAO;;AAGT,SAAgB,uBAGd,OAAyC;;CACzC,IAAI,WAAW;AAOf,6BAJE,MAAM,MAAM,0FAAU,KAAK,MAAK,OAC5B,OAAO,KAAK,MAAM,aAAa,CAAC,SAAS,GACzC,OAAO,gCAAK,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE,CAAC,EAE7C,SAAS,OAAO;EACrB,MAAM,UAAU,GAAG,MAAM,IAAI;AAC7B,aAAW,KAAK,IAAI,UAAU,QAAQ,OAAO;GAC7C;AAEF,QAAO;;AAGT,SAAgB,mBAGd,KAA4B,UAAoB;AAChD,mBAAkB,IAAI,QAAQ,QAAQ;EACpC,MAAM,SAAS,QAAQ,OAAO,OAAO,CAAC,CAAC,IAAI,IAAI;EAE/C,IAAI,cAAiC,EAAE;AAEvC,MAAI,QAAQ,KACV,QAAO,KAAK,IAAI,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,UAAU;AAC/D,eAAY,SAAS;IACrB;MAEF,eAAc;AAGhB,aAAW,YAAY,CAAC;AAExB,MAAI,CAAC,UAAU,SACb,QAAO;GACL,GAAG;IACF,IAAI,KAAK;GACX;AAGH,MAAI,UAAU,CAAC,UAAU;GACvB,MAAM,GAAG,IAAI,KAAK,GAAG,GAAG,SAAS;AACjC,UAAO;;AAGT,SAAO;GACP;;AAGJ,SAAgB,kBAGd,KAA4B;;CAC5B,MAAM,qCAA0B,IAAI,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;AAErE,QAAO,CAAC,kDACN,IAAI,MAAM,SAAQ,yHAAmB,IAAI,MACxC,aAAa,QAAQ,SAAS,IAAI;;AAIvC,SAAgB,iBAGd,KAA4B;;AAC5B,0DACE,IAAI,MAAM,SAAQ,2HAAkB,IAAI,OACtC,IAAI,MAAM,QAAQ,mBAAmB,SAAS,CAAC,CAAC,IAAI,QAAQ;;AAIlE,SAAgB,4BAGd,KAA4B;CAC5B,IAAI,kBAAkB;CACtB,IAAI,aAAa;AAEjB,QAAO,mBAAmB,WAAW,UAAU;AAC7C,eAAa,IAAI,MAAM,OAAO,WAAW,UAAU,KAAK;AACxD,oBAAkB,kBAAkB,IAAI;;AAG1C,QAAO;;AAGT,SAAgB,6BAGd,KAA4B;CAC5B,MAAM,YAAY,iBAAiB,IAAI;AAEvC,cAAa;AACX,MAAI,CAAC,UAAW;AAChB,qBAAmB,IAAI"}
+{"version":3,"file":"rowExpandingFeature.utils.cjs","names":["cloneState"],"sources":["../../../src/features/row-expanding/rowExpandingFeature.utils.ts"],"sourcesContent":["import { cloneState } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type {\n  ExpandedState,\n  ExpandedStateList,\n} from './rowExpandingFeature.types'\n\n/**\n * Returns the default expanded 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 = getDefaultExpandedState()\n * ```\n */\nexport function getDefaultExpandedState(): ExpandedState {\n  return {}\n}\n\n/**\n * Schedules an automatic reset for expanded.\n *\n * The reset only runs when the related feature options allow automatic resets for the current table state change.\n *\n * @example\n * ```ts\n * table_autoResetExpanded(table)\n * ```\n */\nexport function table_autoResetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  if (\n    table.options.autoResetAll ??\n    table.options.autoResetExpanded ??\n    !table.options.manualExpanding\n  ) {\n    queueMicrotask(() => table_resetExpanded(table))\n  }\n}\n\n/**\n * Updates the table's expanded 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_setExpanded(table, (old) => old)\n * ```\n */\nexport function table_setExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<ExpandedState>) {\n  table.options.onExpandedChange?.(updater)\n}\n\n/**\n * Toggles all rows expanded for the table.\n *\n * This is the table-level convenience API used by UI controls that affect many columns or rows at once.\n *\n * @example\n * ```ts\n * table_toggleAllRowsExpanded(table)\n * ```\n */\nexport function table_toggleAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, expanded?: boolean) {\n  if (expanded ?? !table_getIsAllRowsExpanded(table)) {\n    table_setExpanded(table, true)\n  } else {\n    table_setExpanded(table, {})\n  }\n}\n\n/**\n * Resets the table's expanded 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_resetExpanded(table)\n * table_resetExpanded(table, true)\n * ```\n */\nexport function table_resetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setExpanded(\n    table,\n    defaultState ? {} : cloneState(table.initialState.expanded ?? {}),\n  )\n}\n\n/**\n * Returns can some rows expand for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getCanSomeRowsExpand(table)\n * ```\n */\nexport function table_getCanSomeRowsExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getPrePaginatedRowModel()\n    .flatRows.some((row) => row_getCanExpand(row))\n}\n\n/**\n * Returns an event handler for all rows expanded handler.\n *\n * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.\n *\n * @example\n * ```ts\n * const value = table_getToggleAllRowsExpandedHandler(table)\n * ```\n */\nexport function table_getToggleAllRowsExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (e: unknown) => {\n    ;(e as any).persist?.()\n    table_toggleAllRowsExpanded(table)\n  }\n}\n\n/**\n * Returns is some rows expanded for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getIsSomeRowsExpanded(table)\n * ```\n */\nexport function table_getIsSomeRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n  return expanded === true || Object.values(expanded).some(Boolean)\n}\n\n/**\n * Returns is all rows expanded for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getIsAllRowsExpanded(table)\n * ```\n */\nexport function table_getIsAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n\n  // If expanded is true, save some cycles and return true\n  if (expanded === true) {\n    return true\n  }\n\n  if (!Object.keys(expanded).length) {\n    return false\n  }\n\n  // If any row is not expanded, return false\n  if (table.getRowModel().flatRows.some((row) => !row_getIsExpanded(row))) {\n    return false\n  }\n\n  // They must all be expanded :shrug:\n  return true\n}\n\n/**\n * Returns expanded depth for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getExpandedDepth(table)\n * ```\n */\nexport function table_getExpandedDepth<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  let maxDepth = 0\n\n  const rowIds =\n    table.atoms.expanded?.get() === true\n      ? Object.keys(table.getRowModel().rowsById)\n      : Object.keys(table.atoms.expanded?.get() ?? {})\n\n  rowIds.forEach((id) => {\n    const splitId = id.split('.')\n    maxDepth = Math.max(maxDepth, splitId.length)\n  })\n\n  return maxDepth\n}\n\n/**\n * Toggles expanded for a row.\n *\n * The update is routed through the table state updater for the owning feature state slice.\n *\n * @example\n * ```ts\n * row_toggleExpanded(row)\n * ```\n */\nexport function row_toggleExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>, expanded?: boolean) {\n  table_setExpanded(row.table, (old) => {\n    const exists = old === true ? true : !!old[row.id]\n\n    let oldExpanded: ExpandedStateList = {}\n\n    if (old === true) {\n      Object.keys(row.table.getRowModel().rowsById).forEach((rowId) => {\n        oldExpanded[rowId] = true\n      })\n    } else {\n      oldExpanded = old\n    }\n\n    expanded = expanded ?? !exists\n\n    if (!exists && expanded) {\n      return {\n        ...oldExpanded,\n        [row.id]: true,\n      }\n    }\n\n    if (exists && !expanded) {\n      const { [row.id]: _, ...rest } = oldExpanded\n      return rest\n    }\n\n    return old\n  })\n}\n\n/**\n * Returns is expanded for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getIsExpanded(row)\n * ```\n */\nexport function row_getIsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const expanded: ExpandedState = row.table.atoms.expanded?.get() ?? {}\n\n  return !!(\n    row.table.options.getIsRowExpanded?.(row) ??\n    (expanded === true || expanded[row.id])\n  )\n}\n\n/**\n * Returns whether a row can use expand.\n *\n * This evaluates row data, table options, and feature-specific enablement rules.\n *\n * @example\n * ```ts\n * const value = row_getCanExpand(row)\n * ```\n */\nexport function row_getCanExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  return (\n    row.table.options.getRowCanExpand?.(row) ??\n    ((row.table.options.enableExpanding ?? true) && !!row.subRows.length)\n  )\n}\n\n/**\n * Returns is all parents expanded for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getIsAllParentsExpanded(row)\n * ```\n */\nexport function row_getIsAllParentsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  let isFullyExpanded = true\n  let currentRow = row\n\n  while (isFullyExpanded && currentRow.parentId) {\n    currentRow = row.table.getRow(currentRow.parentId, true)\n    isFullyExpanded = row_getIsExpanded(row)\n  }\n\n  return isFullyExpanded\n}\n\n/**\n * Returns an event handler for toggling expanded handler.\n *\n * The handler is intended for direct use in row-level controls such as expansion or selection buttons.\n *\n * @example\n * ```ts\n * const value = row_getToggleExpandedHandler(row)\n * ```\n */\nexport function row_getToggleExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const canExpand = row_getCanExpand(row)\n\n  return () => {\n    if (!canExpand) return\n    row_toggleExpanded(row)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAoBA,SAAgB,0BAAyC;CACvD,OAAO,EAAE;;;;;;;;;;;;AAaX,SAAgB,wBAGd,OAAyC;CACzC,IACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,qBACd,CAAC,MAAM,QAAQ,iBAEf,qBAAqB,oBAAoB,MAAM,CAAC;;;;;;;;;;;;AAcpD,SAAgB,kBAGd,OAAyC,SAAiC;;CAC1E,iDAAM,SAAQ,6GAAmB,QAAQ;;;;;;;;;;;;AAa3C,SAAgB,4BAGd,OAAyC,UAAoB;CAC7D,IAAI,YAAY,CAAC,2BAA2B,MAAM,EAChD,kBAAkB,OAAO,KAAK;MAE9B,kBAAkB,OAAO,EAAE,CAAC;;;;;;;;;;;;;AAehC,SAAgB,oBAGd,OAAyC,cAAwB;CACjE,kBACE,OACA,eAAe,EAAE,GAAGA,yBAAW,MAAM,aAAa,YAAY,EAAE,CAAC,CAClE;;;;;;;;;;;;AAaH,SAAgB,2BAGd,OAAyC;CACzC,OAAO,MACJ,yBAAyB,CACzB,SAAS,MAAM,QAAQ,iBAAiB,IAAI,CAAC;;;;;;;;;;;;AAalD,SAAgB,sCAGd,OAAyC;CACzC,QAAQ,MAAe;;EACpB,YAAC,EAAU,4DAAW;EACvB,4BAA4B,MAAM;;;;;;;;;;;;;AActC,SAAgB,4BAGd,OAAyC;;CACzC,MAAM,qCAAW,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;CAClD,OAAO,aAAa,QAAQ,OAAO,OAAO,SAAS,CAAC,KAAK,QAAQ;;;;;;;;;;;;AAanE,SAAgB,2BAGd,OAAyC;;CACzC,MAAM,sCAAW,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE;CAGlD,IAAI,aAAa,MACf,OAAO;CAGT,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,QACzB,OAAO;CAIT,IAAI,MAAM,aAAa,CAAC,SAAS,MAAM,QAAQ,CAAC,kBAAkB,IAAI,CAAC,EACrE,OAAO;CAIT,OAAO;;;;;;;;;;;;AAaT,SAAgB,uBAGd,OAAyC;;CACzC,IAAI,WAAW;CAOf,4BAJE,MAAM,MAAM,0FAAU,KAAK,MAAK,OAC5B,OAAO,KAAK,MAAM,aAAa,CAAC,SAAS,GACzC,OAAO,gCAAK,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE,CAAC,EAE7C,SAAS,OAAO;EACrB,MAAM,UAAU,GAAG,MAAM,IAAI;EAC7B,WAAW,KAAK,IAAI,UAAU,QAAQ,OAAO;GAC7C;CAEF,OAAO;;;;;;;;;;;;AAaT,SAAgB,mBAGd,KAA4B,UAAoB;CAChD,kBAAkB,IAAI,QAAQ,QAAQ;EACpC,MAAM,SAAS,QAAQ,OAAO,OAAO,CAAC,CAAC,IAAI,IAAI;EAE/C,IAAI,cAAiC,EAAE;EAEvC,IAAI,QAAQ,MACV,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,UAAU;GAC/D,YAAY,SAAS;IACrB;OAEF,cAAc;EAGhB,WAAW,YAAY,CAAC;EAExB,IAAI,CAAC,UAAU,UACb,OAAO;GACL,GAAG;IACF,IAAI,KAAK;GACX;EAGH,IAAI,UAAU,CAAC,UAAU;GACvB,MAAM,GAAG,IAAI,KAAK,GAAG,GAAG,SAAS;GACjC,OAAO;;EAGT,OAAO;GACP;;;;;;;;;;;;AAaJ,SAAgB,kBAGd,KAA4B;;CAC5B,MAAM,qCAA0B,IAAI,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;CAErE,OAAO,CAAC,kDACN,IAAI,MAAM,SAAQ,yHAAmB,IAAI,MACxC,aAAa,QAAQ,SAAS,IAAI;;;;;;;;;;;;AAcvC,SAAgB,iBAGd,KAA4B;;CAC5B,yDACE,IAAI,MAAM,SAAQ,2HAAkB,IAAI,OACtC,IAAI,MAAM,QAAQ,mBAAmB,SAAS,CAAC,CAAC,IAAI,QAAQ;;;;;;;;;;;;AAclE,SAAgB,4BAGd,KAA4B;CAC5B,IAAI,kBAAkB;CACtB,IAAI,aAAa;CAEjB,OAAO,mBAAmB,WAAW,UAAU;EAC7C,aAAa,IAAI,MAAM,OAAO,WAAW,UAAU,KAAK;EACxD,kBAAkB,kBAAkB,IAAI;;CAG1C,OAAO;;;;;;;;;;;;AAaT,SAAgB,6BAGd,KAA4B;CAC5B,MAAM,YAAY,iBAAiB,IAAI;CAEvC,aAAa;EACX,IAAI,CAAC,WAAW;EAChB,mBAAmB,IAAI"}

package/dist/features/row-expanding/rowExpandingFeature.utils.d.cts

@@ -5,20 +5,171 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/row-expanding/rowExpandingFeature.utils.d.ts
+/**
+ * Returns the default expanded state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultExpandedState()
+ * ```
+ */
 declare function getDefaultExpandedState(): ExpandedState;
+/**
+ * Schedules an automatic reset for expanded.
+ *
+ * The reset only runs when the related feature options allow automatic resets for the current table state change.
+ *
+ * @example
+ * ```ts
+ * table_autoResetExpanded(table)
+ * ```
+ */
 declare function table_autoResetExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Updates the table's expanded state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setExpanded(table, (old) => old)
+ * ```
+ */
 declare function table_setExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ExpandedState>): void;
+/**
+ * Toggles all rows expanded for the table.
+ *
+ * This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+ *
+ * @example
+ * ```ts
+ * table_toggleAllRowsExpanded(table)
+ * ```
+ */
 declare function table_toggleAllRowsExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, expanded?: boolean): void;
+/**
+ * Resets the table's expanded state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetExpanded(table)
+ * table_resetExpanded(table, true)
+ * ```
+ */
 declare function table_resetExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Returns can some rows expand for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanSomeRowsExpand(table)
+ * ```
+ */
 declare function table_getCanSomeRowsExpand<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns an event handler for all rows expanded handler.
+ *
+ * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+ *
+ * @example
+ * ```ts
+ * const value = table_getToggleAllRowsExpandedHandler(table)
+ * ```
+ */
 declare function table_getToggleAllRowsExpandedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+/**
+ * Returns is some rows expanded for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsSomeRowsExpanded(table)
+ * ```
+ */
 declare function table_getIsSomeRowsExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns is all rows expanded for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsAllRowsExpanded(table)
+ * ```
+ */
 declare function table_getIsAllRowsExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns expanded depth for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getExpandedDepth(table)
+ * ```
+ */
 declare function table_getExpandedDepth<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number;
+/**
+ * Toggles expanded for a row.
+ *
+ * The update is routed through the table state updater for the owning feature state slice.
+ *
+ * @example
+ * ```ts
+ * row_toggleExpanded(row)
+ * ```
+ */
 declare function row_toggleExpanded<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, expanded?: boolean): void;
+/**
+ * Returns is expanded for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getIsExpanded(row)
+ * ```
+ */
 declare function row_getIsExpanded<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns whether a row can use expand.
+ *
+ * This evaluates row data, table options, and feature-specific enablement rules.
+ *
+ * @example
+ * ```ts
+ * const value = row_getCanExpand(row)
+ * ```
+ */
 declare function row_getCanExpand<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns is all parents expanded for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getIsAllParentsExpanded(row)
+ * ```
+ */
 declare function row_getIsAllParentsExpanded<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns an event handler for toggling expanded handler.
+ *
+ * The handler is intended for direct use in row-level controls such as expansion or selection buttons.
+ *
+ * @example
+ * ```ts
+ * const value = row_getToggleExpandedHandler(row)
+ * ```
+ */
 declare function row_getToggleExpandedHandler<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): () => void;
 //#endregion
 export { getDefaultExpandedState, row_getCanExpand, row_getIsAllParentsExpanded, row_getIsExpanded, row_getToggleExpandedHandler, row_toggleExpanded, table_autoResetExpanded, table_getCanSomeRowsExpand, table_getExpandedDepth, table_getIsAllRowsExpanded, table_getIsSomeRowsExpanded, table_getToggleAllRowsExpandedHandler, table_resetExpanded, table_setExpanded, table_toggleAllRowsExpanded };

package/dist/features/row-expanding/rowExpandingFeature.utils.d.ts

@@ -5,20 +5,171 @@ import { TableFeatures } from "../../types/TableFeatures.js";
 import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/row-expanding/rowExpandingFeature.utils.d.ts
+/**
+ * Returns the default expanded state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultExpandedState()
+ * ```
+ */
 declare function getDefaultExpandedState(): ExpandedState;
+/**
+ * Schedules an automatic reset for expanded.
+ *
+ * The reset only runs when the related feature options allow automatic resets for the current table state change.
+ *
+ * @example
+ * ```ts
+ * table_autoResetExpanded(table)
+ * ```
+ */
 declare function table_autoResetExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Updates the table's expanded state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setExpanded(table, (old) => old)
+ * ```
+ */
 declare function table_setExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ExpandedState>): void;
+/**
+ * Toggles all rows expanded for the table.
+ *
+ * This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+ *
+ * @example
+ * ```ts
+ * table_toggleAllRowsExpanded(table)
+ * ```
+ */
 declare function table_toggleAllRowsExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, expanded?: boolean): void;
+/**
+ * Resets the table's expanded state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetExpanded(table)
+ * table_resetExpanded(table, true)
+ * ```
+ */
 declare function table_resetExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Returns can some rows expand for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanSomeRowsExpand(table)
+ * ```
+ */
 declare function table_getCanSomeRowsExpand<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns an event handler for all rows expanded handler.
+ *
+ * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+ *
+ * @example
+ * ```ts
+ * const value = table_getToggleAllRowsExpandedHandler(table)
+ * ```
+ */
 declare function table_getToggleAllRowsExpandedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+/**
+ * Returns is some rows expanded for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsSomeRowsExpanded(table)
+ * ```
+ */
 declare function table_getIsSomeRowsExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns is all rows expanded for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsAllRowsExpanded(table)
+ * ```
+ */
 declare function table_getIsAllRowsExpanded<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns expanded depth for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getExpandedDepth(table)
+ * ```
+ */
 declare function table_getExpandedDepth<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number;
+/**
+ * Toggles expanded for a row.
+ *
+ * The update is routed through the table state updater for the owning feature state slice.
+ *
+ * @example
+ * ```ts
+ * row_toggleExpanded(row)
+ * ```
+ */
 declare function row_toggleExpanded<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, expanded?: boolean): void;
+/**
+ * Returns is expanded for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getIsExpanded(row)
+ * ```
+ */
 declare function row_getIsExpanded<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns whether a row can use expand.
+ *
+ * This evaluates row data, table options, and feature-specific enablement rules.
+ *
+ * @example
+ * ```ts
+ * const value = row_getCanExpand(row)
+ * ```
+ */
 declare function row_getCanExpand<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns is all parents expanded for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getIsAllParentsExpanded(row)
+ * ```
+ */
 declare function row_getIsAllParentsExpanded<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns an event handler for toggling expanded handler.
+ *
+ * The handler is intended for direct use in row-level controls such as expansion or selection buttons.
+ *
+ * @example
+ * ```ts
+ * const value = row_getToggleExpandedHandler(row)
+ * ```
+ */
 declare function row_getToggleExpandedHandler<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): () => void;
 //#endregion
 export { getDefaultExpandedState, row_getCanExpand, row_getIsAllParentsExpanded, row_getIsExpanded, row_getToggleExpandedHandler, row_toggleExpanded, table_autoResetExpanded, table_getCanSomeRowsExpand, table_getExpandedDepth, table_getIsAllRowsExpanded, table_getIsSomeRowsExpanded, table_getToggleAllRowsExpandedHandler, table_resetExpanded, table_setExpanded, table_toggleAllRowsExpanded };