@tanstack/table-core 9.0.0-alpha.47 → 9.0.0-alpha.48

package/dist/fns/aggregationFns.cjs

@@ -1,7 +1,10 @@
 
 //#region src/fns/aggregationFns.ts
 /**
-* Aggregation function for summing up the values of a column.
+* Sums numeric child-row values for a grouped column.
+*
+* Non-number values contribute `0`. Child rows are used so nested group totals
+* can reuse already aggregated values.
 */
 const aggregationFn_sum = (columnId, _leafRows, childRows) => {
 	return childRows.reduce((sumValue, next) => {
@@ -10,7 +13,10 @@ const aggregationFn_sum = (columnId, _leafRows, childRows) => {
 	}, 0);
 };
 /**
-* Aggregation function for finding the minimum value of a column.
+* Finds the minimum numeric child-row value for a grouped column.
+*
+* Nullish and non-number values are ignored. Returns `undefined` when no
+* numeric value is found.
 */
 const aggregationFn_min = (columnId, _leafRows, childRows) => {
 	let minValue;
@@ -21,7 +27,10 @@ const aggregationFn_min = (columnId, _leafRows, childRows) => {
 	return minValue;
 };
 /**
-* Aggregation function for finding the maximum value of a column.
+* Finds the maximum numeric child-row value for a grouped column.
+*
+* Nullish and non-number values are ignored. Returns `undefined` when no
+* numeric value is found.
 */
 const aggregationFn_max = (columnId, _leafRows, childRows) => {
 	let maxValue;
@@ -32,7 +41,10 @@ const aggregationFn_max = (columnId, _leafRows, childRows) => {
 	return maxValue;
 };
 /**
-* Aggregation function for finding the extent (min and max) of a column.
+* Finds the numeric extent for a grouped column.
+*
+* Returns `[min, max]`, where each entry is `undefined` when no numeric value is
+* present.
 */
 const aggregationFn_extent = (columnId, _leafRows, childRows) => {
 	let minValue;
@@ -48,7 +60,10 @@ const aggregationFn_extent = (columnId, _leafRows, childRows) => {
 	return [minValue, maxValue];
 };
 /**
-* Aggregation function for finding the mean (average) of a column.
+* Averages numeric leaf-row values for a grouped column.
+*
+* Number-like values are coerced with unary `+`; nullish and non-numeric values
+* are ignored.
 */
 const aggregationFn_mean = (columnId, leafRows) => {
 	let count = 0;
@@ -69,7 +84,10 @@ const aggregationFn_mean = (columnId, leafRows) => {
 	if (count) return sumValue / count;
 };
 /**
-* Aggregation function for finding the median value of a column.
+* Computes the median of numeric leaf-row values for a grouped column.
+*
+* All values must be numbers. If any value is non-numeric, or no leaf rows are
+* present, the result is `undefined`.
 */
 const aggregationFn_median = (columnId, leafRows) => {
 	if (!leafRows.length) return;
@@ -85,7 +103,9 @@ const aggregationFn_median = (columnId, leafRows) => {
 	return values.length % 2 !== 0 ? values[mid] : (values[mid - 1] + values[mid]) / 2;
 };
 /**
-* Aggregation function for finding the unique values of a column.
+* Collects unique leaf-row values for a grouped column.
+*
+* Values are compared with JavaScript `Set` semantics.
 */
 const aggregationFn_unique = (columnId, leafRows) => {
 	const set = /* @__PURE__ */ new Set();
@@ -93,7 +113,9 @@ const aggregationFn_unique = (columnId, leafRows) => {
 	return Array.from(set.values());
 };
 /**
-* Aggregation function for finding the count of unique values of a column.
+* Counts unique leaf-row values for a grouped column.
+*
+* Values are compared with JavaScript `Set` semantics.
 */
 const aggregationFn_uniqueCount = (columnId, leafRows) => {
 	const set = /* @__PURE__ */ new Set();
@@ -101,7 +123,9 @@ const aggregationFn_uniqueCount = (columnId, leafRows) => {
 	return set.size;
 };
 /**
-* Aggregation function for counting the number of rows in a column.
+* Counts the number of leaf rows in the group.
+*
+* The column id is ignored because the result is based only on group size.
 */
 const aggregationFn_count = (_columnId, leafRows) => {
 	return leafRows.length;

package/dist/fns/aggregationFns.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"aggregationFns.cjs","names":[],"sources":["../../src/fns/aggregationFns.ts"],"sourcesContent":["import 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: Array<number> = new Array(leafRows.length)\n  for (let i = 0; i < leafRows.length; i++) {\n    const v = leafRows[i]!.getValue(columnId)\n    if (typeof v !== 'number') return\n    values[i] = v\n  }\n\n  if (values.length === 1) {\n    return values[0]\n  }\n\n  const mid = Math.floor(values.length / 2)\n  values.sort((a, b) => a - b)\n  return values.length % 2 !== 0\n    ? values[mid]\n    : (values[mid - 1]! + values[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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return Array.from(set.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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return set.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":";;;;;AAQA,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,SAAwB,IAAI,MAAM,SAAS,OAAO;CACxD,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;EACxC,MAAM,IAAI,SAAS,GAAI,SAAS,SAAS;EACzC,IAAI,OAAO,MAAM,UAAU;EAC3B,OAAO,KAAK;;CAGd,IAAI,OAAO,WAAW,GACpB,OAAO,OAAO;CAGhB,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,EAAE;CACzC,OAAO,MAAM,GAAG,MAAM,IAAI,EAAE;CAC5B,OAAO,OAAO,SAAS,MAAM,IACzB,OAAO,QACN,OAAO,MAAM,KAAM,OAAO,QAAS;;;;;AAM1C,MAAa,wBAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,MAAM,KAAK,IAAI,QAAQ,CAAC;;;;;AAMjC,MAAa,6BAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,IAAI;;;;;AAMb,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"}
+{"version":3,"file":"aggregationFns.cjs","names":[],"sources":["../../src/fns/aggregationFns.ts"],"sourcesContent":["import 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 * Sums numeric child-row values for a grouped column.\n *\n * Non-number values contribute `0`. Child rows are used so nested group totals\n * can reuse already aggregated values.\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 * Finds the minimum numeric child-row value for a grouped column.\n *\n * Nullish and non-number values are ignored. Returns `undefined` when no\n * numeric value is found.\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 * Finds the maximum numeric child-row value for a grouped column.\n *\n * Nullish and non-number values are ignored. Returns `undefined` when no\n * numeric value is found.\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 * Finds the numeric extent for a grouped column.\n *\n * Returns `[min, max]`, where each entry is `undefined` when no numeric value is\n * present.\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 * Averages numeric leaf-row values for a grouped column.\n *\n * Number-like values are coerced with unary `+`; nullish and non-numeric values\n * are ignored.\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 * Computes the median of numeric leaf-row values for a grouped column.\n *\n * All values must be numbers. If any value is non-numeric, or no leaf rows are\n * present, the result is `undefined`.\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: Array<number> = new Array(leafRows.length)\n  for (let i = 0; i < leafRows.length; i++) {\n    const v = leafRows[i]!.getValue(columnId)\n    if (typeof v !== 'number') return\n    values[i] = v\n  }\n\n  if (values.length === 1) {\n    return values[0]\n  }\n\n  const mid = Math.floor(values.length / 2)\n  values.sort((a, b) => a - b)\n  return values.length % 2 !== 0\n    ? values[mid]\n    : (values[mid - 1]! + values[mid]!) / 2\n}\n\n/**\n * Collects unique leaf-row values for a grouped column.\n *\n * Values are compared with JavaScript `Set` semantics.\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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return Array.from(set.values())\n}\n\n/**\n * Counts unique leaf-row values for a grouped column.\n *\n * Values are compared with JavaScript `Set` semantics.\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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return set.size\n}\n\n/**\n * Counts the number of leaf rows in the group.\n *\n * The column id is ignored because the result is based only on group size.\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":";;;;;;;;AAWA,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;;;;;;;;AASP,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;;;;;;;;AAST,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;;;;;;;;AAST,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;;;;;;;;AAS7B,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;;;;;;;;AAW/B,MAAa,wBAIX,UACA,aACG;CACH,IAAI,CAAC,SAAS,QACZ;CAGF,MAAM,SAAwB,IAAI,MAAM,SAAS,OAAO;CACxD,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;EACxC,MAAM,IAAI,SAAS,GAAI,SAAS,SAAS;EACzC,IAAI,OAAO,MAAM,UAAU;EAC3B,OAAO,KAAK;;CAGd,IAAI,OAAO,WAAW,GACpB,OAAO,OAAO;CAGhB,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,EAAE;CACzC,OAAO,MAAM,GAAG,MAAM,IAAI,EAAE;CAC5B,OAAO,OAAO,SAAS,MAAM,IACzB,OAAO,QACN,OAAO,MAAM,KAAM,OAAO,QAAS;;;;;;;AAQ1C,MAAa,wBAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,MAAM,KAAK,IAAI,QAAQ,CAAC;;;;;;;AAQjC,MAAa,6BAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,IAAI;;;;;;;AAQb,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

@@ -2,39 +2,63 @@ import { AggregationFn } from "../features/column-grouping/columnGroupingFeature
 
 //#region src/fns/aggregationFns.d.ts
 /**
- * Aggregation function for summing up the values of a column.
+ * Sums numeric child-row values for a grouped column.
+ *
+ * Non-number values contribute `0`. Child rows are used so nested group totals
+ * can reuse already aggregated values.
  */
 declare const aggregationFn_sum: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the minimum value of a column.
+ * Finds the minimum numeric child-row value for a grouped column.
+ *
+ * Nullish and non-number values are ignored. Returns `undefined` when no
+ * numeric value is found.
  */
 declare const aggregationFn_min: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the maximum value of a column.
+ * Finds the maximum numeric child-row value for a grouped column.
+ *
+ * Nullish and non-number values are ignored. Returns `undefined` when no
+ * numeric value is found.
  */
 declare const aggregationFn_max: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the extent (min and max) of a column.
+ * Finds the numeric extent for a grouped column.
+ *
+ * Returns `[min, max]`, where each entry is `undefined` when no numeric value is
+ * present.
  */
 declare const aggregationFn_extent: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the mean (average) of a column.
+ * Averages numeric leaf-row values for a grouped column.
+ *
+ * Number-like values are coerced with unary `+`; nullish and non-numeric values
+ * are ignored.
  */
 declare const aggregationFn_mean: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the median value of a column.
+ * Computes the median of numeric leaf-row values for a grouped column.
+ *
+ * All values must be numbers. If any value is non-numeric, or no leaf rows are
+ * present, the result is `undefined`.
  */
 declare const aggregationFn_median: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the unique values of a column.
+ * Collects unique leaf-row values for a grouped column.
+ *
+ * Values are compared with JavaScript `Set` semantics.
  */
 declare const aggregationFn_unique: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the count of unique values of a column.
+ * Counts unique leaf-row values for a grouped column.
+ *
+ * Values are compared with JavaScript `Set` semantics.
  */
 declare const aggregationFn_uniqueCount: AggregationFn<any, any>;
 /**
- * Aggregation function for counting the number of rows in a column.
+ * Counts the number of leaf rows in the group.
+ *
+ * The column id is ignored because the result is based only on group size.
  */
 declare const aggregationFn_count: AggregationFn<any, any>;
 /**

package/dist/fns/aggregationFns.d.ts

@@ -2,39 +2,63 @@ import { AggregationFn } from "../features/column-grouping/columnGroupingFeature
 
 //#region src/fns/aggregationFns.d.ts
 /**
- * Aggregation function for summing up the values of a column.
+ * Sums numeric child-row values for a grouped column.
+ *
+ * Non-number values contribute `0`. Child rows are used so nested group totals
+ * can reuse already aggregated values.
  */
 declare const aggregationFn_sum: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the minimum value of a column.
+ * Finds the minimum numeric child-row value for a grouped column.
+ *
+ * Nullish and non-number values are ignored. Returns `undefined` when no
+ * numeric value is found.
  */
 declare const aggregationFn_min: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the maximum value of a column.
+ * Finds the maximum numeric child-row value for a grouped column.
+ *
+ * Nullish and non-number values are ignored. Returns `undefined` when no
+ * numeric value is found.
  */
 declare const aggregationFn_max: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the extent (min and max) of a column.
+ * Finds the numeric extent for a grouped column.
+ *
+ * Returns `[min, max]`, where each entry is `undefined` when no numeric value is
+ * present.
  */
 declare const aggregationFn_extent: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the mean (average) of a column.
+ * Averages numeric leaf-row values for a grouped column.
+ *
+ * Number-like values are coerced with unary `+`; nullish and non-numeric values
+ * are ignored.
  */
 declare const aggregationFn_mean: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the median value of a column.
+ * Computes the median of numeric leaf-row values for a grouped column.
+ *
+ * All values must be numbers. If any value is non-numeric, or no leaf rows are
+ * present, the result is `undefined`.
  */
 declare const aggregationFn_median: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the unique values of a column.
+ * Collects unique leaf-row values for a grouped column.
+ *
+ * Values are compared with JavaScript `Set` semantics.
  */
 declare const aggregationFn_unique: AggregationFn<any, any>;
 /**
- * Aggregation function for finding the count of unique values of a column.
+ * Counts unique leaf-row values for a grouped column.
+ *
+ * Values are compared with JavaScript `Set` semantics.
  */
 declare const aggregationFn_uniqueCount: AggregationFn<any, any>;
 /**
- * Aggregation function for counting the number of rows in a column.
+ * Counts the number of leaf rows in the group.
+ *
+ * The column id is ignored because the result is based only on group size.
  */
 declare const aggregationFn_count: AggregationFn<any, any>;
 /**

package/dist/fns/aggregationFns.js

@@ -1,6 +1,9 @@
 //#region src/fns/aggregationFns.ts
 /**
-* Aggregation function for summing up the values of a column.
+* Sums numeric child-row values for a grouped column.
+*
+* Non-number values contribute `0`. Child rows are used so nested group totals
+* can reuse already aggregated values.
 */
 const aggregationFn_sum = (columnId, _leafRows, childRows) => {
 	return childRows.reduce((sumValue, next) => {
@@ -9,7 +12,10 @@ const aggregationFn_sum = (columnId, _leafRows, childRows) => {
 	}, 0);
 };
 /**
-* Aggregation function for finding the minimum value of a column.
+* Finds the minimum numeric child-row value for a grouped column.
+*
+* Nullish and non-number values are ignored. Returns `undefined` when no
+* numeric value is found.
 */
 const aggregationFn_min = (columnId, _leafRows, childRows) => {
 	let minValue;
@@ -20,7 +26,10 @@ const aggregationFn_min = (columnId, _leafRows, childRows) => {
 	return minValue;
 };
 /**
-* Aggregation function for finding the maximum value of a column.
+* Finds the maximum numeric child-row value for a grouped column.
+*
+* Nullish and non-number values are ignored. Returns `undefined` when no
+* numeric value is found.
 */
 const aggregationFn_max = (columnId, _leafRows, childRows) => {
 	let maxValue;
@@ -31,7 +40,10 @@ const aggregationFn_max = (columnId, _leafRows, childRows) => {
 	return maxValue;
 };
 /**
-* Aggregation function for finding the extent (min and max) of a column.
+* Finds the numeric extent for a grouped column.
+*
+* Returns `[min, max]`, where each entry is `undefined` when no numeric value is
+* present.
 */
 const aggregationFn_extent = (columnId, _leafRows, childRows) => {
 	let minValue;
@@ -47,7 +59,10 @@ const aggregationFn_extent = (columnId, _leafRows, childRows) => {
 	return [minValue, maxValue];
 };
 /**
-* Aggregation function for finding the mean (average) of a column.
+* Averages numeric leaf-row values for a grouped column.
+*
+* Number-like values are coerced with unary `+`; nullish and non-numeric values
+* are ignored.
 */
 const aggregationFn_mean = (columnId, leafRows) => {
 	let count = 0;
@@ -68,7 +83,10 @@ const aggregationFn_mean = (columnId, leafRows) => {
 	if (count) return sumValue / count;
 };
 /**
-* Aggregation function for finding the median value of a column.
+* Computes the median of numeric leaf-row values for a grouped column.
+*
+* All values must be numbers. If any value is non-numeric, or no leaf rows are
+* present, the result is `undefined`.
 */
 const aggregationFn_median = (columnId, leafRows) => {
 	if (!leafRows.length) return;
@@ -84,7 +102,9 @@ const aggregationFn_median = (columnId, leafRows) => {
 	return values.length % 2 !== 0 ? values[mid] : (values[mid - 1] + values[mid]) / 2;
 };
 /**
-* Aggregation function for finding the unique values of a column.
+* Collects unique leaf-row values for a grouped column.
+*
+* Values are compared with JavaScript `Set` semantics.
 */
 const aggregationFn_unique = (columnId, leafRows) => {
 	const set = /* @__PURE__ */ new Set();
@@ -92,7 +112,9 @@ const aggregationFn_unique = (columnId, leafRows) => {
 	return Array.from(set.values());
 };
 /**
-* Aggregation function for finding the count of unique values of a column.
+* Counts unique leaf-row values for a grouped column.
+*
+* Values are compared with JavaScript `Set` semantics.
 */
 const aggregationFn_uniqueCount = (columnId, leafRows) => {
 	const set = /* @__PURE__ */ new Set();
@@ -100,7 +122,9 @@ const aggregationFn_uniqueCount = (columnId, leafRows) => {
 	return set.size;
 };
 /**
-* Aggregation function for counting the number of rows in a column.
+* Counts the number of leaf rows in the group.
+*
+* The column id is ignored because the result is based only on group size.
 */
 const aggregationFn_count = (_columnId, leafRows) => {
 	return leafRows.length;

package/dist/fns/aggregationFns.js.map

@@ -1 +1 @@
-{"version":3,"file":"aggregationFns.js","names":[],"sources":["../../src/fns/aggregationFns.ts"],"sourcesContent":["import 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: Array<number> = new Array(leafRows.length)\n  for (let i = 0; i < leafRows.length; i++) {\n    const v = leafRows[i]!.getValue(columnId)\n    if (typeof v !== 'number') return\n    values[i] = v\n  }\n\n  if (values.length === 1) {\n    return values[0]\n  }\n\n  const mid = Math.floor(values.length / 2)\n  values.sort((a, b) => a - b)\n  return values.length % 2 !== 0\n    ? values[mid]\n    : (values[mid - 1]! + values[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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return Array.from(set.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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return set.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":";;;;AAQA,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,SAAwB,IAAI,MAAM,SAAS,OAAO;CACxD,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;EACxC,MAAM,IAAI,SAAS,GAAI,SAAS,SAAS;EACzC,IAAI,OAAO,MAAM,UAAU;EAC3B,OAAO,KAAK;;CAGd,IAAI,OAAO,WAAW,GACpB,OAAO,OAAO;CAGhB,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,EAAE;CACzC,OAAO,MAAM,GAAG,MAAM,IAAI,EAAE;CAC5B,OAAO,OAAO,SAAS,MAAM,IACzB,OAAO,QACN,OAAO,MAAM,KAAM,OAAO,QAAS;;;;;AAM1C,MAAa,wBAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,MAAM,KAAK,IAAI,QAAQ,CAAC;;;;;AAMjC,MAAa,6BAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,IAAI;;;;;AAMb,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"}
+{"version":3,"file":"aggregationFns.js","names":[],"sources":["../../src/fns/aggregationFns.ts"],"sourcesContent":["import 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 * Sums numeric child-row values for a grouped column.\n *\n * Non-number values contribute `0`. Child rows are used so nested group totals\n * can reuse already aggregated values.\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 * Finds the minimum numeric child-row value for a grouped column.\n *\n * Nullish and non-number values are ignored. Returns `undefined` when no\n * numeric value is found.\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 * Finds the maximum numeric child-row value for a grouped column.\n *\n * Nullish and non-number values are ignored. Returns `undefined` when no\n * numeric value is found.\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 * Finds the numeric extent for a grouped column.\n *\n * Returns `[min, max]`, where each entry is `undefined` when no numeric value is\n * present.\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 * Averages numeric leaf-row values for a grouped column.\n *\n * Number-like values are coerced with unary `+`; nullish and non-numeric values\n * are ignored.\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 * Computes the median of numeric leaf-row values for a grouped column.\n *\n * All values must be numbers. If any value is non-numeric, or no leaf rows are\n * present, the result is `undefined`.\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: Array<number> = new Array(leafRows.length)\n  for (let i = 0; i < leafRows.length; i++) {\n    const v = leafRows[i]!.getValue(columnId)\n    if (typeof v !== 'number') return\n    values[i] = v\n  }\n\n  if (values.length === 1) {\n    return values[0]\n  }\n\n  const mid = Math.floor(values.length / 2)\n  values.sort((a, b) => a - b)\n  return values.length % 2 !== 0\n    ? values[mid]\n    : (values[mid - 1]! + values[mid]!) / 2\n}\n\n/**\n * Collects unique leaf-row values for a grouped column.\n *\n * Values are compared with JavaScript `Set` semantics.\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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return Array.from(set.values())\n}\n\n/**\n * Counts unique leaf-row values for a grouped column.\n *\n * Values are compared with JavaScript `Set` semantics.\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  const set = new Set<unknown>()\n  for (let i = 0; i < leafRows.length; i++) {\n    set.add(leafRows[i]!.getValue(columnId))\n  }\n  return set.size\n}\n\n/**\n * Counts the number of leaf rows in the group.\n *\n * The column id is ignored because the result is based only on group size.\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":";;;;;;;AAWA,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;;;;;;;;AASP,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;;;;;;;;AAST,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;;;;;;;;AAST,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;;;;;;;;AAS7B,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;;;;;;;;AAW/B,MAAa,wBAIX,UACA,aACG;CACH,IAAI,CAAC,SAAS,QACZ;CAGF,MAAM,SAAwB,IAAI,MAAM,SAAS,OAAO;CACxD,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;EACxC,MAAM,IAAI,SAAS,GAAI,SAAS,SAAS;EACzC,IAAI,OAAO,MAAM,UAAU;EAC3B,OAAO,KAAK;;CAGd,IAAI,OAAO,WAAW,GACpB,OAAO,OAAO;CAGhB,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,EAAE;CACzC,OAAO,MAAM,GAAG,MAAM,IAAI,EAAE;CAC5B,OAAO,OAAO,SAAS,MAAM,IACzB,OAAO,QACN,OAAO,MAAM,KAAM,OAAO,QAAS;;;;;;;AAQ1C,MAAa,wBAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,MAAM,KAAK,IAAI,QAAQ,CAAC;;;;;;;AAQjC,MAAa,6BAIX,UACA,aACG;CACH,MAAM,sBAAM,IAAI,KAAc;CAC9B,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KACnC,IAAI,IAAI,SAAS,GAAI,SAAS,SAAS,CAAC;CAE1C,OAAO,IAAI;;;;;;;AAQb,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/filterFns.cjs

@@ -1,21 +1,28 @@
 
 //#region src/fns/filterFns.ts
 /**
-* Filter function for checking if a value is exactly equal to a given value. (JS === comparison)
+* Keeps rows whose column value is strictly equal to the filter value.
+*
+* Uses JavaScript `===` comparison and auto-removes empty filter values.
 */
 const filterFn_equals = (row, columnId, filterValue) => {
 	return row.getValue(columnId) === filterValue;
 };
 filterFn_equals.autoRemove = (val) => testFalsy(val);
 /**
-* Filter function for checking if a value is weakly equal to a given value. (JS == comparison)
+* Keeps rows whose column value is loosely equal to the filter value.
+*
+* Uses JavaScript `==` comparison and auto-removes empty filter values. This is
+* useful for matching string input against numeric row values.
 */
 const filterFn_weakEquals = (row, columnId, filterValue) => {
 	return row.getValue(columnId) == filterValue;
 };
 filterFn_weakEquals.autoRemove = (val) => testFalsy(val);
 /**
-* Filter function for checking if a string includes a given substring. (Case-sensitive)
+* Keeps rows whose stringified column value includes the filter text.
+*
+* Matching is case-sensitive and empty filter values are auto-removed.
 */
 const filterFn_includesStringSensitive = (row, columnId, filterValue) => {
 	var _row$getValue;
@@ -23,7 +30,10 @@ const filterFn_includesStringSensitive = (row, columnId, filterValue) => {
 };
 filterFn_includesStringSensitive.autoRemove = (val) => testFalsy(val);
 /**
-* Filter function for checking if a string includes a given substring. (Non-case-sensitive)
+* Keeps rows whose stringified column value includes the filter text.
+*
+* Both values are lowercased before comparison, and empty filter values are
+* auto-removed.
 */
 const filterFn_includesString = (row, columnId, filterValue) => {
 	var _row$getValue2;
@@ -31,7 +41,10 @@ const filterFn_includesString = (row, columnId, filterValue) => {
 };
 filterFn_includesString.autoRemove = (val) => testFalsy(val);
 /**
-* Filter function for checking if a string is exactly equal to a given string. (Non-case-sensitive)
+* Keeps rows whose stringified column value equals the filter text.
+*
+* Both values are lowercased before comparison, and empty filter values are
+* auto-removed.
 */
 const filterFn_equalsString = (row, columnId, filterValue) => {
 	var _row$getValue3;
@@ -39,7 +52,9 @@ const filterFn_equalsString = (row, columnId, filterValue) => {
 };
 filterFn_equalsString.autoRemove = (val) => testFalsy(val);
 /**
-* Filter function for checking if a string is exactly equal to a given string. (Case-sensitive)
+* Keeps rows whose stringified column value exactly equals the filter text.
+*
+* Matching is case-sensitive and empty filter values are auto-removed.
 */
 const filterFn_equalsStringSensitive = (row, columnId, filterValue) => {
 	var _row$getValue4;
@@ -47,7 +62,10 @@ const filterFn_equalsStringSensitive = (row, columnId, filterValue) => {
 };
 filterFn_equalsStringSensitive.autoRemove = (val) => testFalsy(val);
 /**
-* Filter function for checking if a number is greater than a given number.
+* Keeps rows whose value is greater than the filter value.
+*
+* Numeric values are compared numerically when both sides can be coerced to
+* numbers; otherwise normalized strings are compared.
 */
 const filterFn_greaterThan = (row, columnId, filterValue) => {
 	const rowValue = row.getValue(columnId);
@@ -58,38 +76,51 @@ const filterFn_greaterThan = (row, columnId, filterValue) => {
 };
 filterFn_greaterThan.resolveFilterValue = (val) => testFalsy(val);
 /**
-* Filter function for checking if a number is greater than or equal to a given number.
+* Keeps rows whose value is greater than or equal to the filter value.
+*
+* Delegates to the built-in greater-than and equality comparisons.
 */
 const filterFn_greaterThanOrEqualTo = (row, columnId, filterValue) => {
 	return filterFn_greaterThan(row, columnId, filterValue) || filterFn_equals(row, columnId, filterValue);
 };
 filterFn_greaterThanOrEqualTo.resolveFilterValue = (val) => testFalsy(val);
 /**
-* Filter function for checking if a number is less than a given number.
+* Keeps rows whose value is less than the filter value.
+*
+* This is implemented as the inverse of greater-than-or-equal comparison.
 */
 const filterFn_lessThan = (row, columnId, filterValue) => {
 	return !filterFn_greaterThanOrEqualTo(row, columnId, filterValue);
 };
 filterFn_lessThan.resolveFilterValue = (val) => testFalsy(val);
 /**
-* Filter function for checking if a number is less than or equal to a given number.
+* Keeps rows whose value is less than or equal to the filter value.
+*
+* This is implemented as the inverse of greater-than comparison.
 */
 const filterFn_lessThanOrEqualTo = (row, columnId, filterValue) => {
 	return !filterFn_greaterThan(row, columnId, filterValue);
 };
 filterFn_lessThanOrEqualTo.resolveFilterValue = (val) => testFalsy(val);
 /**
-* Filter function for checking if a number or a string is between two given values.
+* Keeps rows whose value falls between an exclusive min/max pair.
+*
+* Blank range endpoints are treated as open-ended.
 */
 const filterFn_between = (row, columnId, filterValues) => (["", void 0].includes(filterValues[0]) || filterFn_greaterThan(row, columnId, filterValues[0])) && (!isNaN(+filterValues[0]) && !isNaN(+filterValues[1]) && +filterValues[0] > +filterValues[1] || ["", void 0].includes(filterValues[1]) || filterFn_lessThan(row, columnId, filterValues[1]));
 filterFn_between.autoRemove = (val) => !val;
 /**
-* Filter function for checking if a number or a string is between two given values or equal to them.
+* Keeps rows whose value falls between an inclusive min/max pair.
+*
+* Blank range endpoints are treated as open-ended.
 */
 const filterFn_betweenInclusive = (row, columnId, filterValues) => (["", void 0].includes(filterValues[0]) || filterFn_greaterThanOrEqualTo(row, columnId, filterValues[0])) && (!isNaN(+filterValues[0]) && !isNaN(+filterValues[1]) && +filterValues[0] > +filterValues[1] || ["", void 0].includes(filterValues[1]) || filterFn_lessThanOrEqualTo(row, columnId, filterValues[1]));
 filterFn_betweenInclusive.autoRemove = (val) => !val;
 /**
-* Filter function for checking if a number is within a given range.
+* Keeps rows whose numeric value is inside an inclusive `[min, max]` range.
+*
+* Filter values are normalized so blank endpoints become open-ended and
+* reversed endpoints are swapped.
 */
 const filterFn_inNumberRange = (row, columnId, filterValue) => {
 	const [min, max] = filterValue;
@@ -111,20 +142,20 @@ filterFn_inNumberRange.resolveFilterValue = (val) => {
 };
 filterFn_inNumberRange.autoRemove = (val) => testFalsy(val) || testFalsy(val[0]) && testFalsy(val[1]);
 /**
-* Filter function for checking if an array has a given value.
+* Keeps rows whose scalar column value equals at least one filter value.
 */
 const filterFn_arrHas = (row, columnId, filterValue) => {
 	return filterValue.some((val) => row.getValue(columnId) === val);
 };
 /**
-* Filter function for checking if an array includes a given value.
+* Keeps rows whose array or string column value includes at least one filter value.
 */
 const filterFn_arrIncludes = (row, columnId, filterValue) => {
 	return filterValue.some((val) => row.getValue(columnId).includes(val));
 };
 filterFn_arrIncludes.autoRemove = (val) => testFalsy(val) || !(val === null || val === void 0 ? void 0 : val.length);
 /**
-* Filter function for checking if an array includes all of the given values.
+* Keeps rows whose array column value includes every filter value.
 */
 const filterFn_arrIncludesAll = (row, columnId, filterValue) => {
 	const value = row.getValue(columnId);
@@ -133,7 +164,7 @@ const filterFn_arrIncludesAll = (row, columnId, filterValue) => {
 };
 filterFn_arrIncludesAll.autoRemove = (val) => testFalsy(val) || !(val === null || val === void 0 ? void 0 : val.length);
 /**
-* Filter function for checking if an array includes any of the given values.
+* Keeps rows whose array column value includes at least one filter value.
 */
 const filterFn_arrIncludesSome = (row, columnId, filterValue) => {
 	const value = row.getValue(columnId);