@tanstack/table-core 9.0.0-beta.46 → 9.0.0-beta.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (212) hide show
  1. package/dist/core/row-models/coreRowModelsFeature.types.d.cts +1 -1
  2. package/dist/core/row-models/coreRowModelsFeature.types.d.ts +1 -1
  3. package/dist/core/row-models/coreRowModelsFeature.utils.cjs +1 -1
  4. package/dist/core/row-models/coreRowModelsFeature.utils.cjs.map +1 -1
  5. package/dist/core/row-models/coreRowModelsFeature.utils.d.cts +1 -1
  6. package/dist/core/row-models/coreRowModelsFeature.utils.d.ts +1 -1
  7. package/dist/core/row-models/coreRowModelsFeature.utils.js +1 -1
  8. package/dist/core/row-models/coreRowModelsFeature.utils.js.map +1 -1
  9. package/dist/features/aggregation/aggregationFeature.cjs +38 -0
  10. package/dist/features/aggregation/aggregationFeature.cjs.map +1 -0
  11. package/dist/features/aggregation/aggregationFeature.d.cts +10 -0
  12. package/dist/features/aggregation/aggregationFeature.d.ts +10 -0
  13. package/dist/features/aggregation/aggregationFeature.js +38 -0
  14. package/dist/features/aggregation/aggregationFeature.js.map +1 -0
  15. package/dist/features/aggregation/aggregationFeature.types.cjs +13 -0
  16. package/dist/features/aggregation/aggregationFeature.types.cjs.map +1 -0
  17. package/dist/features/aggregation/aggregationFeature.types.d.cts +172 -0
  18. package/dist/features/aggregation/aggregationFeature.types.d.ts +172 -0
  19. package/dist/features/aggregation/aggregationFeature.types.js +12 -0
  20. package/dist/features/aggregation/aggregationFeature.types.js.map +1 -0
  21. package/dist/features/aggregation/aggregationFeature.utils.cjs +198 -0
  22. package/dist/features/aggregation/aggregationFeature.utils.cjs.map +1 -0
  23. package/dist/features/aggregation/aggregationFeature.utils.d.cts +33 -0
  24. package/dist/features/aggregation/aggregationFeature.utils.d.ts +33 -0
  25. package/dist/features/aggregation/aggregationFeature.utils.js +192 -0
  26. package/dist/features/aggregation/aggregationFeature.utils.js.map +1 -0
  27. package/dist/features/aggregation/aggregationFns.cjs +240 -0
  28. package/dist/features/aggregation/aggregationFns.cjs.map +1 -0
  29. package/dist/features/aggregation/aggregationFns.d.cts +67 -0
  30. package/dist/features/aggregation/aggregationFns.d.ts +67 -0
  31. package/dist/features/aggregation/aggregationFns.js +229 -0
  32. package/dist/features/aggregation/aggregationFns.js.map +1 -0
  33. package/dist/features/column-filtering/columnFilteringFeature.types.d.cts +43 -3
  34. package/dist/features/column-filtering/columnFilteringFeature.types.d.ts +43 -3
  35. package/dist/features/column-filtering/columnFilteringFeature.utils.cjs +18 -9
  36. package/dist/features/column-filtering/columnFilteringFeature.utils.cjs.map +1 -1
  37. package/dist/features/column-filtering/columnFilteringFeature.utils.d.cts +6 -2
  38. package/dist/features/column-filtering/columnFilteringFeature.utils.d.ts +6 -2
  39. package/dist/features/column-filtering/columnFilteringFeature.utils.js +18 -9
  40. package/dist/features/column-filtering/columnFilteringFeature.utils.js.map +1 -1
  41. package/dist/features/column-filtering/createFilteredRowModel.cjs +7 -2
  42. package/dist/features/column-filtering/createFilteredRowModel.cjs.map +1 -1
  43. package/dist/features/column-filtering/createFilteredRowModel.d.cts +6 -2
  44. package/dist/features/column-filtering/createFilteredRowModel.d.ts +6 -2
  45. package/dist/features/column-filtering/createFilteredRowModel.js +7 -2
  46. package/dist/features/column-filtering/createFilteredRowModel.js.map +1 -1
  47. package/dist/features/column-filtering/filterFns.cjs +399 -0
  48. package/dist/features/column-filtering/filterFns.cjs.map +1 -0
  49. package/dist/features/column-filtering/filterFns.d.cts +210 -0
  50. package/dist/features/column-filtering/filterFns.d.ts +210 -0
  51. package/dist/features/column-filtering/filterFns.js +375 -0
  52. package/dist/features/column-filtering/filterFns.js.map +1 -0
  53. package/dist/features/column-grouping/columnGroupingFeature.cjs +3 -12
  54. package/dist/features/column-grouping/columnGroupingFeature.cjs.map +1 -1
  55. package/dist/features/column-grouping/columnGroupingFeature.d.cts +1 -1
  56. package/dist/features/column-grouping/columnGroupingFeature.d.ts +1 -1
  57. package/dist/features/column-grouping/columnGroupingFeature.js +4 -13
  58. package/dist/features/column-grouping/columnGroupingFeature.js.map +1 -1
  59. package/dist/features/column-grouping/columnGroupingFeature.types.d.cts +6 -49
  60. package/dist/features/column-grouping/columnGroupingFeature.types.d.ts +6 -49
  61. package/dist/features/column-grouping/columnGroupingFeature.utils.cjs +0 -50
  62. package/dist/features/column-grouping/columnGroupingFeature.utils.cjs.map +1 -1
  63. package/dist/features/column-grouping/columnGroupingFeature.utils.d.cts +2 -39
  64. package/dist/features/column-grouping/columnGroupingFeature.utils.d.ts +2 -39
  65. package/dist/features/column-grouping/columnGroupingFeature.utils.js +2 -49
  66. package/dist/features/column-grouping/columnGroupingFeature.utils.js.map +1 -1
  67. package/dist/features/column-grouping/createGroupedRowModel.cjs +23 -13
  68. package/dist/features/column-grouping/createGroupedRowModel.cjs.map +1 -1
  69. package/dist/features/column-grouping/createGroupedRowModel.d.cts +2 -3
  70. package/dist/features/column-grouping/createGroupedRowModel.d.ts +2 -3
  71. package/dist/features/column-grouping/createGroupedRowModel.js +25 -15
  72. package/dist/features/column-grouping/createGroupedRowModel.js.map +1 -1
  73. package/dist/features/global-filtering/globalFilteringFeature.utils.cjs +4 -2
  74. package/dist/features/global-filtering/globalFilteringFeature.utils.cjs.map +1 -1
  75. package/dist/features/global-filtering/globalFilteringFeature.utils.d.cts +2 -6
  76. package/dist/features/global-filtering/globalFilteringFeature.utils.d.ts +2 -6
  77. package/dist/features/global-filtering/globalFilteringFeature.utils.js +4 -2
  78. package/dist/features/global-filtering/globalFilteringFeature.utils.js.map +1 -1
  79. package/dist/features/row-sorting/createSortedRowModel.cjs +6 -2
  80. package/dist/features/row-sorting/createSortedRowModel.cjs.map +1 -1
  81. package/dist/features/row-sorting/createSortedRowModel.d.cts +6 -2
  82. package/dist/features/row-sorting/createSortedRowModel.d.ts +6 -2
  83. package/dist/features/row-sorting/createSortedRowModel.js +6 -2
  84. package/dist/features/row-sorting/createSortedRowModel.js.map +1 -1
  85. package/dist/features/row-sorting/rowSortingFeature.types.d.cts +32 -3
  86. package/dist/features/row-sorting/rowSortingFeature.types.d.ts +32 -3
  87. package/dist/features/row-sorting/rowSortingFeature.utils.cjs +20 -5
  88. package/dist/features/row-sorting/rowSortingFeature.utils.cjs.map +1 -1
  89. package/dist/features/row-sorting/rowSortingFeature.utils.js +20 -5
  90. package/dist/features/row-sorting/rowSortingFeature.utils.js.map +1 -1
  91. package/dist/{fns → features/row-sorting}/sortFns.cjs +69 -22
  92. package/dist/features/row-sorting/sortFns.cjs.map +1 -0
  93. package/dist/features/row-sorting/sortFns.d.cts +98 -0
  94. package/dist/features/row-sorting/sortFns.d.ts +98 -0
  95. package/dist/{fns → features/row-sorting}/sortFns.js +69 -23
  96. package/dist/features/row-sorting/sortFns.js.map +1 -0
  97. package/dist/features/stockFeatures.cjs +2 -0
  98. package/dist/features/stockFeatures.cjs.map +1 -1
  99. package/dist/features/stockFeatures.d.cts +2 -0
  100. package/dist/features/stockFeatures.d.ts +2 -0
  101. package/dist/features/stockFeatures.js +2 -0
  102. package/dist/features/stockFeatures.js.map +1 -1
  103. package/dist/helpers/tableFeatures.cjs +5 -4
  104. package/dist/helpers/tableFeatures.cjs.map +1 -1
  105. package/dist/helpers/tableFeatures.d.cts +5 -4
  106. package/dist/helpers/tableFeatures.d.ts +5 -4
  107. package/dist/helpers/tableFeatures.js +5 -4
  108. package/dist/helpers/tableFeatures.js.map +1 -1
  109. package/dist/index.cjs +18 -3
  110. package/dist/index.d.cts +10 -8
  111. package/dist/index.d.ts +10 -8
  112. package/dist/index.js +6 -4
  113. package/dist/static-functions.cjs +8 -3
  114. package/dist/static-functions.d.cts +3 -2
  115. package/dist/static-functions.d.ts +3 -2
  116. package/dist/static-functions.js +3 -2
  117. package/dist/types/Cell.d.cts +3 -1
  118. package/dist/types/Cell.d.ts +3 -1
  119. package/dist/types/Column.d.cts +4 -2
  120. package/dist/types/Column.d.ts +4 -2
  121. package/dist/types/ColumnDef.d.cts +5 -3
  122. package/dist/types/ColumnDef.d.ts +5 -3
  123. package/dist/types/Row.d.cts +3 -1
  124. package/dist/types/Row.d.ts +3 -1
  125. package/dist/types/RowModel.d.cts +1 -1
  126. package/dist/types/RowModel.d.ts +1 -1
  127. package/dist/types/RowModelFns.d.cts +3 -3
  128. package/dist/types/RowModelFns.d.ts +3 -3
  129. package/dist/types/Table.d.cts +1 -1
  130. package/dist/types/Table.d.ts +1 -1
  131. package/dist/types/TableFeatures.d.cts +19 -11
  132. package/dist/types/TableFeatures.d.ts +19 -11
  133. package/dist/types/TableOptions.d.cts +5 -3
  134. package/dist/types/TableOptions.d.ts +5 -3
  135. package/dist/types/TableState.d.cts +1 -1
  136. package/dist/types/TableState.d.ts +1 -1
  137. package/dist/types/type-utils.d.cts +8 -1
  138. package/dist/types/type-utils.d.ts +8 -1
  139. package/dist/worker/initTableWorker.cjs.map +1 -1
  140. package/dist/worker/initTableWorker.js.map +1 -1
  141. package/package.json +1 -1
  142. package/skills/aggregation/SKILL.md +131 -0
  143. package/skills/api-not-found/SKILL.md +1 -1
  144. package/skills/client-vs-server/SKILL.md +1 -1
  145. package/skills/column-faceting/SKILL.md +11 -5
  146. package/skills/column-filtering/SKILL.md +8 -3
  147. package/skills/column-ordering/SKILL.md +1 -1
  148. package/skills/column-pinning/SKILL.md +1 -1
  149. package/skills/column-resizing/SKILL.md +1 -1
  150. package/skills/column-sizing/SKILL.md +1 -1
  151. package/skills/column-visibility/SKILL.md +1 -1
  152. package/skills/core/SKILL.md +1 -1
  153. package/skills/custom-features/SKILL.md +1 -1
  154. package/skills/expanding/SKILL.md +1 -1
  155. package/skills/global-filtering/SKILL.md +3 -3
  156. package/skills/grouping/SKILL.md +12 -13
  157. package/skills/migrate-v8-to-v9/SKILL.md +21 -8
  158. package/skills/pagination/SKILL.md +1 -1
  159. package/skills/row-pinning/SKILL.md +1 -1
  160. package/skills/row-selection/SKILL.md +1 -1
  161. package/skills/sorting/SKILL.md +9 -3
  162. package/skills/table-features/SKILL.md +19 -13
  163. package/skills/typescript/SKILL.md +1 -1
  164. package/src/core/row-models/coreRowModelsFeature.utils.ts +1 -1
  165. package/src/features/aggregation/aggregationFeature.ts +59 -0
  166. package/src/features/aggregation/aggregationFeature.types.ts +312 -0
  167. package/src/features/aggregation/aggregationFeature.utils.ts +401 -0
  168. package/src/features/aggregation/aggregationFns.ts +336 -0
  169. package/src/features/column-filtering/columnFilteringFeature.types.ts +61 -1
  170. package/src/features/column-filtering/columnFilteringFeature.utils.ts +33 -19
  171. package/src/features/column-filtering/createFilteredRowModel.ts +13 -3
  172. package/src/features/column-filtering/filterFns.ts +533 -0
  173. package/src/features/column-grouping/columnGroupingFeature.ts +1 -20
  174. package/src/features/column-grouping/columnGroupingFeature.types.ts +4 -86
  175. package/src/features/column-grouping/columnGroupingFeature.utils.ts +1 -88
  176. package/src/features/column-grouping/createGroupedRowModel.ts +32 -38
  177. package/src/features/global-filtering/globalFilteringFeature.utils.ts +9 -1
  178. package/src/features/row-sorting/createSortedRowModel.ts +6 -2
  179. package/src/features/row-sorting/rowSortingFeature.types.ts +54 -2
  180. package/src/features/row-sorting/rowSortingFeature.utils.ts +46 -14
  181. package/src/{fns → features/row-sorting}/sortFns.ts +95 -81
  182. package/src/features/stockFeatures.ts +3 -0
  183. package/src/helpers/tableFeatures.ts +5 -4
  184. package/src/index.ts +7 -8
  185. package/src/static-functions.ts +1 -0
  186. package/src/types/Cell.ts +2 -0
  187. package/src/types/Column.ts +3 -1
  188. package/src/types/ColumnDef.ts +6 -3
  189. package/src/types/Row.ts +2 -0
  190. package/src/types/RowModelFns.ts +3 -3
  191. package/src/types/TableFeatures.ts +19 -11
  192. package/src/types/TableOptions.ts +5 -1
  193. package/src/types/type-utils.ts +8 -0
  194. package/src/worker/initTableWorker.ts +1 -1
  195. package/dist/fns/aggregationFns.cjs +0 -163
  196. package/dist/fns/aggregationFns.cjs.map +0 -1
  197. package/dist/fns/aggregationFns.d.cts +0 -85
  198. package/dist/fns/aggregationFns.d.ts +0 -85
  199. package/dist/fns/aggregationFns.js +0 -153
  200. package/dist/fns/aggregationFns.js.map +0 -1
  201. package/dist/fns/filterFns.cjs +0 -242
  202. package/dist/fns/filterFns.cjs.map +0 -1
  203. package/dist/fns/filterFns.d.cts +0 -178
  204. package/dist/fns/filterFns.d.ts +0 -178
  205. package/dist/fns/filterFns.js +0 -226
  206. package/dist/fns/filterFns.js.map +0 -1
  207. package/dist/fns/sortFns.cjs.map +0 -1
  208. package/dist/fns/sortFns.d.cts +0 -65
  209. package/dist/fns/sortFns.d.ts +0 -65
  210. package/dist/fns/sortFns.js.map +0 -1
  211. package/src/fns/aggregationFns.ts +0 -245
  212. package/src/fns/filterFns.ts +0 -455
@@ -0,0 +1,229 @@
1
+ import { constructAggregationFn } from "./aggregationFeature.types.js";
2
+
3
+ //#region src/features/aggregation/aggregationFns.ts
4
+ function isNumber(value) {
5
+ return typeof value === "number";
6
+ }
7
+ function isValidDate(value) {
8
+ return value instanceof Date && !Number.isNaN(value.getTime());
9
+ }
10
+ function getRangeKind(value) {
11
+ if (isNumber(value)) return "number";
12
+ if (isValidDate(value)) return "date";
13
+ }
14
+ function compareRangeValues(left, right) {
15
+ return (left instanceof Date ? left.getTime() : left) - (right instanceof Date ? right.getTime() : right);
16
+ }
17
+ function collectRangeValues(context) {
18
+ const values = [];
19
+ let kind;
20
+ for (let i = 0; i < context.rows.length; i++) {
21
+ const value = context.getValue(context.rows[i]);
22
+ const valueKind = getRangeKind(value);
23
+ if (!valueKind) continue;
24
+ kind ??= valueKind;
25
+ if (valueKind === kind) values.push(value);
26
+ }
27
+ return values;
28
+ }
29
+ /**
30
+ * Sums numeric row values. Non-number values contribute zero. As in the
31
+ * previous API, `NaN` is a number and therefore propagates through the sum.
32
+ */
33
+ const aggregationFn_sum = constructAggregationFn({
34
+ aggregate: (context) => {
35
+ let sum = 0;
36
+ for (let i = 0; i < context.rows.length; i++) {
37
+ const value = context.getValue(context.rows[i]);
38
+ sum += typeof value === "number" ? value : 0;
39
+ }
40
+ return sum;
41
+ },
42
+ merge: ({ childResults }) => {
43
+ let sum = 0;
44
+ for (let i = 0; i < childResults.length; i++) {
45
+ const value = childResults[i];
46
+ if (isNumber(value)) sum += value;
47
+ }
48
+ return sum;
49
+ }
50
+ });
51
+ /**
52
+ * Finds the minimum numeric or Date value. Invalid value types are ignored;
53
+ * `NaN` preserves the legacy numeric seeding behavior.
54
+ */
55
+ const aggregationFn_min = constructAggregationFn({
56
+ aggregate: (context) => {
57
+ const values = collectRangeValues(context);
58
+ let result = values[0];
59
+ for (let i = 1; i < values.length; i++) if (compareRangeValues(values[i], result) < 0) result = values[i];
60
+ return result;
61
+ },
62
+ merge: ({ childResults }) => {
63
+ let result;
64
+ let kind;
65
+ for (let i = 0; i < childResults.length; i++) {
66
+ const value = childResults[i];
67
+ const valueKind = getRangeKind(value);
68
+ if (!valueKind) continue;
69
+ kind ??= valueKind;
70
+ if (kind !== valueKind) continue;
71
+ if (result === void 0 || compareRangeValues(value, result) < 0) result = value;
72
+ }
73
+ return result;
74
+ }
75
+ });
76
+ /**
77
+ * Finds the maximum numeric or Date value. Invalid value types are ignored;
78
+ * `NaN` preserves the legacy numeric seeding behavior.
79
+ */
80
+ const aggregationFn_max = constructAggregationFn({
81
+ aggregate: (context) => {
82
+ const values = collectRangeValues(context);
83
+ let result = values[0];
84
+ for (let i = 1; i < values.length; i++) if (compareRangeValues(values[i], result) > 0) result = values[i];
85
+ return result;
86
+ },
87
+ merge: ({ childResults }) => {
88
+ let result;
89
+ let kind;
90
+ for (let i = 0; i < childResults.length; i++) {
91
+ const value = childResults[i];
92
+ const valueKind = getRangeKind(value);
93
+ if (!valueKind) continue;
94
+ kind ??= valueKind;
95
+ if (kind !== valueKind) continue;
96
+ if (result === void 0 || compareRangeValues(value, result) > 0) result = value;
97
+ }
98
+ return result;
99
+ }
100
+ });
101
+ /**
102
+ * Finds the minimum and maximum numeric or Date values. Empty inputs return
103
+ * `[undefined, undefined]`, preserving the previous built-in result shape.
104
+ */
105
+ const aggregationFn_extent = constructAggregationFn({
106
+ aggregate: (context) => {
107
+ const values = collectRangeValues(context);
108
+ if (!values.length) return [void 0, void 0];
109
+ let min = values[0];
110
+ let max = values[0];
111
+ for (let i = 1; i < values.length; i++) {
112
+ const value = values[i];
113
+ if (compareRangeValues(value, min) < 0) min = value;
114
+ if (compareRangeValues(value, max) > 0) max = value;
115
+ }
116
+ return [min, max];
117
+ },
118
+ merge: ({ childResults }) => {
119
+ let result = [void 0, void 0];
120
+ let kind;
121
+ for (let i = 0; i < childResults.length; i++) {
122
+ const extent = childResults[i];
123
+ const valueKind = getRangeKind(extent[0]);
124
+ if (!valueKind) continue;
125
+ kind ??= valueKind;
126
+ if (kind !== valueKind) continue;
127
+ if (result[0] === void 0) result = [extent[0], extent[1]];
128
+ else {
129
+ if (compareRangeValues(extent[0], result[0]) < 0) result[0] = extent[0];
130
+ if (compareRangeValues(extent[1], result[1]) > 0) result[1] = extent[1];
131
+ }
132
+ }
133
+ return result;
134
+ }
135
+ });
136
+ /**
137
+ * Averages number and number-like row values. Nullish and non-numeric values
138
+ * are ignored; other values retain the legacy unary-plus coercion behavior.
139
+ */
140
+ const aggregationFn_mean = constructAggregationFn({ aggregate: (context) => {
141
+ let count = 0;
142
+ let sum = 0;
143
+ for (let i = 0; i < context.rows.length; i++) {
144
+ const value = context.getValue(context.rows[i]);
145
+ if (value == null) continue;
146
+ const numberValue = typeof value === "number" ? value : +value;
147
+ if (!Number.isNaN(numberValue)) {
148
+ count++;
149
+ sum += numberValue;
150
+ }
151
+ }
152
+ return count ? sum / count : void 0;
153
+ } });
154
+ /**
155
+ * Computes the median when every row value is a number. Returns `undefined`
156
+ * for empty inputs or when any value is non-numeric.
157
+ */
158
+ const aggregationFn_median = constructAggregationFn({ aggregate: (context) => {
159
+ if (!context.rows.length) return void 0;
160
+ const values = new Array(context.rows.length);
161
+ for (let i = 0; i < context.rows.length; i++) {
162
+ const value = context.getValue(context.rows[i]);
163
+ if (typeof value !== "number") return void 0;
164
+ values[i] = value;
165
+ }
166
+ values.sort((a, b) => a - b);
167
+ const mid = Math.floor(values.length / 2);
168
+ return values.length % 2 ? values[mid] : (values[mid - 1] + values[mid]) / 2;
169
+ } });
170
+ /** Collects distinct row values using JavaScript `Set` semantics. */
171
+ const aggregationFn_unique = constructAggregationFn({ aggregate: (context) => {
172
+ const values = /* @__PURE__ */ new Set();
173
+ for (let i = 0; i < context.rows.length; i++) values.add(context.getValue(context.rows[i]));
174
+ return Array.from(values);
175
+ } });
176
+ /** Counts distinct row values using JavaScript `Set` semantics. */
177
+ const aggregationFn_uniqueCount = constructAggregationFn({ aggregate: (context) => {
178
+ const values = /* @__PURE__ */ new Set();
179
+ for (let i = 0; i < context.rows.length; i++) values.add(context.getValue(context.rows[i]));
180
+ return values.size;
181
+ } });
182
+ /** Counts rows, independently of the column's values. */
183
+ const aggregationFn_count = constructAggregationFn({
184
+ aggregate: ({ rows }) => rows.length,
185
+ merge: ({ childResults }) => {
186
+ let count = 0;
187
+ for (let i = 0; i < childResults.length; i++) {
188
+ const value = childResults[i];
189
+ if (isNumber(value)) count += value;
190
+ }
191
+ return count;
192
+ }
193
+ });
194
+ /** Returns the first row's value, including a nullish value. */
195
+ const aggregationFn_first = constructAggregationFn({
196
+ aggregate: (context) => context.rows[0] ? context.getValue(context.rows[0]) : void 0,
197
+ merge: ({ childResults }) => childResults[0]
198
+ });
199
+ /** Returns the last row's value, including a nullish value. */
200
+ const aggregationFn_last = constructAggregationFn({
201
+ aggregate: (context) => {
202
+ const row = context.rows[context.rows.length - 1];
203
+ return row ? context.getValue(row) : void 0;
204
+ },
205
+ merge: ({ childResults }) => childResults[childResults.length - 1]
206
+ });
207
+ /**
208
+ * Full built-in registry. Register individual definitions for tree-shaking.
209
+ *
210
+ * @deprecated Import individual `aggregationFn_*` definitions instead for a
211
+ * smaller bundle. This registry remains available for compatibility.
212
+ */
213
+ const aggregationFns = {
214
+ sum: aggregationFn_sum,
215
+ min: aggregationFn_min,
216
+ max: aggregationFn_max,
217
+ extent: aggregationFn_extent,
218
+ mean: aggregationFn_mean,
219
+ median: aggregationFn_median,
220
+ unique: aggregationFn_unique,
221
+ uniqueCount: aggregationFn_uniqueCount,
222
+ count: aggregationFn_count,
223
+ first: aggregationFn_first,
224
+ last: aggregationFn_last
225
+ };
226
+
227
+ //#endregion
228
+ export { aggregationFn_count, aggregationFn_extent, aggregationFn_first, aggregationFn_last, aggregationFn_max, aggregationFn_mean, aggregationFn_median, aggregationFn_min, aggregationFn_sum, aggregationFn_unique, aggregationFn_uniqueCount, aggregationFns };
229
+ //# sourceMappingURL=aggregationFns.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"aggregationFns.js","names":[],"sources":["../../../src/features/aggregation/aggregationFns.ts"],"sourcesContent":["import { constructAggregationFn } from './aggregationFeature.types'\nimport type { AggregationContext } from './aggregationFeature.types'\n\ntype RangeValue = Date | number\n\nfunction isNumber(value: unknown): value is number {\n return typeof value === 'number'\n}\n\nfunction isValidDate(value: unknown): value is Date {\n return value instanceof Date && !Number.isNaN(value.getTime())\n}\n\nfunction getRangeKind(value: unknown): 'date' | 'number' | undefined {\n if (isNumber(value)) return 'number'\n if (isValidDate(value)) return 'date'\n return undefined\n}\n\nfunction compareRangeValues(left: RangeValue, right: RangeValue) {\n const leftValue = left instanceof Date ? left.getTime() : left\n const rightValue = right instanceof Date ? right.getTime() : right\n return leftValue - rightValue\n}\n\nfunction collectRangeValues(context: AggregationContext<any, any, unknown>) {\n const values: Array<RangeValue> = []\n let kind: 'date' | 'number' | undefined\n\n for (let i = 0; i < context.rows.length; i++) {\n const value = context.getValue(context.rows[i]!)\n const valueKind = getRangeKind(value)\n if (!valueKind) continue\n kind ??= valueKind\n if (valueKind === kind) values.push(value as RangeValue)\n }\n\n return values\n}\n\n/**\n * Sums numeric row values. Non-number values contribute zero. As in the\n * previous API, `NaN` is a number and therefore propagates through the sum.\n */\nexport const aggregationFn_sum = constructAggregationFn<\n any,\n any,\n unknown,\n number\n>({\n aggregate: (context) => {\n let sum = 0\n for (let i = 0; i < context.rows.length; i++) {\n const value = context.getValue(context.rows[i]!)\n sum += typeof value === 'number' ? value : 0\n }\n return sum\n },\n merge: ({ childResults }) => {\n let sum = 0\n for (let i = 0; i < childResults.length; i++) {\n const value = childResults[i]\n if (isNumber(value)) sum += value\n }\n return sum\n },\n})\n\n/**\n * Finds the minimum numeric or Date value. Invalid value types are ignored;\n * `NaN` preserves the legacy numeric seeding behavior.\n */\nexport const aggregationFn_min = constructAggregationFn<\n any,\n any,\n unknown,\n RangeValue | undefined\n>({\n aggregate: (context) => {\n const values = collectRangeValues(context)\n let result = values[0]\n for (let i = 1; i < values.length; i++) {\n if (compareRangeValues(values[i]!, result!) < 0) result = values[i]\n }\n return result\n },\n merge: ({ childResults }) => {\n let result: RangeValue | undefined\n let kind: 'date' | 'number' | undefined\n for (let i = 0; i < childResults.length; i++) {\n const value = childResults[i]\n const valueKind = getRangeKind(value)\n if (!valueKind) continue\n kind ??= valueKind\n if (kind !== valueKind) continue\n if (result === undefined || compareRangeValues(value!, result) < 0) {\n result = value\n }\n }\n return result\n },\n})\n\n/**\n * Finds the maximum numeric or Date value. Invalid value types are ignored;\n * `NaN` preserves the legacy numeric seeding behavior.\n */\nexport const aggregationFn_max = constructAggregationFn<\n any,\n any,\n unknown,\n RangeValue | undefined\n>({\n aggregate: (context) => {\n const values = collectRangeValues(context)\n let result = values[0]\n for (let i = 1; i < values.length; i++) {\n if (compareRangeValues(values[i]!, result!) > 0) result = values[i]\n }\n return result\n },\n merge: ({ childResults }) => {\n let result: RangeValue | undefined\n let kind: 'date' | 'number' | undefined\n for (let i = 0; i < childResults.length; i++) {\n const value = childResults[i]\n const valueKind = getRangeKind(value)\n if (!valueKind) continue\n kind ??= valueKind\n if (kind !== valueKind) continue\n if (result === undefined || compareRangeValues(value!, result) > 0) {\n result = value\n }\n }\n return result\n },\n})\n\n/**\n * Finds the minimum and maximum numeric or Date values. Empty inputs return\n * `[undefined, undefined]`, preserving the previous built-in result shape.\n */\nexport const aggregationFn_extent = constructAggregationFn<\n any,\n any,\n unknown,\n [RangeValue | undefined, RangeValue | undefined]\n>({\n aggregate: (context) => {\n const values = collectRangeValues(context)\n if (!values.length) return [undefined, undefined]\n let min = values[0]!\n let max = values[0]!\n for (let i = 1; i < values.length; i++) {\n const value = values[i]!\n if (compareRangeValues(value, min) < 0) min = value\n if (compareRangeValues(value, max) > 0) max = value\n }\n return [min, max]\n },\n merge: ({ childResults }) => {\n let result: [RangeValue | undefined, RangeValue | undefined] = [\n undefined,\n undefined,\n ]\n let kind: 'date' | 'number' | undefined\n for (let i = 0; i < childResults.length; i++) {\n const extent = childResults[i]!\n const valueKind = getRangeKind(extent[0])\n if (!valueKind) continue\n kind ??= valueKind\n if (kind !== valueKind) continue\n if (result[0] === undefined) {\n result = [extent[0], extent[1]]\n } else {\n if (compareRangeValues(extent[0]!, result[0]) < 0) {\n result[0] = extent[0]\n }\n if (compareRangeValues(extent[1]!, result[1]!) > 0) {\n result[1] = extent[1]\n }\n }\n }\n return result\n },\n})\n\n/**\n * Averages number and number-like row values. Nullish and non-numeric values\n * are ignored; other values retain the legacy unary-plus coercion behavior.\n */\nexport const aggregationFn_mean = constructAggregationFn<\n any,\n any,\n unknown,\n number | undefined\n>({\n aggregate: (context) => {\n let count = 0\n let sum = 0\n for (let i = 0; i < context.rows.length; i++) {\n const value = context.getValue(context.rows[i]!)\n if (value == null) continue\n const numberValue = typeof value === 'number' ? value : +value\n if (!Number.isNaN(numberValue)) {\n count++\n sum += numberValue\n }\n }\n return count ? sum / count : undefined\n },\n})\n\n/**\n * Computes the median when every row value is a number. Returns `undefined`\n * for empty inputs or when any value is non-numeric.\n */\nexport const aggregationFn_median = constructAggregationFn<\n any,\n any,\n unknown,\n number | undefined\n>({\n aggregate: (context) => {\n if (!context.rows.length) return undefined\n const values = new Array<number>(context.rows.length)\n for (let i = 0; i < context.rows.length; i++) {\n const value = context.getValue(context.rows[i]!)\n if (typeof value !== 'number') return undefined\n values[i] = value\n }\n values.sort((a, b) => a - b)\n const mid = Math.floor(values.length / 2)\n return values.length % 2\n ? values[mid]\n : (values[mid - 1]! + values[mid]!) / 2\n },\n})\n\n/** Collects distinct row values using JavaScript `Set` semantics. */\nexport const aggregationFn_unique = constructAggregationFn<\n any,\n any,\n unknown,\n Array<unknown>\n>({\n aggregate: (context) => {\n const values = new Set<unknown>()\n for (let i = 0; i < context.rows.length; i++) {\n values.add(context.getValue(context.rows[i]!))\n }\n return Array.from(values)\n },\n})\n\n/** Counts distinct row values using JavaScript `Set` semantics. */\nexport const aggregationFn_uniqueCount = constructAggregationFn<\n any,\n any,\n unknown,\n number\n>({\n aggregate: (context) => {\n const values = new Set<unknown>()\n for (let i = 0; i < context.rows.length; i++) {\n values.add(context.getValue(context.rows[i]!))\n }\n return values.size\n },\n})\n\n/** Counts rows, independently of the column's values. */\nexport const aggregationFn_count = constructAggregationFn<\n any,\n any,\n unknown,\n number\n>({\n aggregate: ({ rows }) => rows.length,\n merge: ({ childResults }) => {\n let count = 0\n for (let i = 0; i < childResults.length; i++) {\n const value = childResults[i]\n if (isNumber(value)) count += value\n }\n return count\n },\n})\n\n/** Returns the first row's value, including a nullish value. */\nexport const aggregationFn_first = constructAggregationFn<\n any,\n any,\n unknown,\n unknown\n>({\n aggregate: (context) =>\n context.rows[0] ? context.getValue(context.rows[0]) : undefined,\n merge: ({ childResults }) => childResults[0],\n})\n\n/** Returns the last row's value, including a nullish value. */\nexport const aggregationFn_last = constructAggregationFn<\n any,\n any,\n unknown,\n unknown\n>({\n aggregate: (context) => {\n const row = context.rows[context.rows.length - 1]\n return row ? context.getValue(row) : undefined\n },\n merge: ({ childResults }) => childResults[childResults.length - 1],\n})\n\n/**\n * Full built-in registry. Register individual definitions for tree-shaking.\n *\n * @deprecated Import individual `aggregationFn_*` definitions instead for a\n * smaller bundle. This registry remains available for compatibility.\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 first: aggregationFn_first,\n last: aggregationFn_last,\n}\n\nexport type BuiltInAggregationFn = keyof typeof aggregationFns\n"],"mappings":";;;AAKA,SAAS,SAAS,OAAiC;CACjD,OAAO,OAAO,UAAU;AAC1B;AAEA,SAAS,YAAY,OAA+B;CAClD,OAAO,iBAAiB,QAAQ,CAAC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC/D;AAEA,SAAS,aAAa,OAA+C;CACnE,IAAI,SAAS,KAAK,GAAG,OAAO;CAC5B,IAAI,YAAY,KAAK,GAAG,OAAO;AAEjC;AAEA,SAAS,mBAAmB,MAAkB,OAAmB;CAG/D,QAFkB,gBAAgB,OAAO,KAAK,QAAQ,IAAI,SACvC,iBAAiB,OAAO,MAAM,QAAQ,IAAI;AAE/D;AAEA,SAAS,mBAAmB,SAAgD;CAC1E,MAAM,SAA4B,CAAC;CACnC,IAAI;CAEJ,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,QAAQ,KAAK;EAC5C,MAAM,QAAQ,QAAQ,SAAS,QAAQ,KAAK,EAAG;EAC/C,MAAM,YAAY,aAAa,KAAK;EACpC,IAAI,CAAC,WAAW;EAChB,SAAS;EACT,IAAI,cAAc,MAAM,OAAO,KAAK,KAAmB;CACzD;CAEA,OAAO;AACT;;;;;AAMA,MAAa,oBAAoB,uBAK/B;CACA,YAAY,YAAY;EACtB,IAAI,MAAM;EACV,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,QAAQ,KAAK;GAC5C,MAAM,QAAQ,QAAQ,SAAS,QAAQ,KAAK,EAAG;GAC/C,OAAO,OAAO,UAAU,WAAW,QAAQ;EAC7C;EACA,OAAO;CACT;CACA,QAAQ,EAAE,mBAAmB;EAC3B,IAAI,MAAM;EACV,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;GAC5C,MAAM,QAAQ,aAAa;GAC3B,IAAI,SAAS,KAAK,GAAG,OAAO;EAC9B;EACA,OAAO;CACT;AACF,CAAC;;;;;AAMD,MAAa,oBAAoB,uBAK/B;CACA,YAAY,YAAY;EACtB,MAAM,SAAS,mBAAmB,OAAO;EACzC,IAAI,SAAS,OAAO;EACpB,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,QAAQ,KACjC,IAAI,mBAAmB,OAAO,IAAK,MAAO,IAAI,GAAG,SAAS,OAAO;EAEnE,OAAO;CACT;CACA,QAAQ,EAAE,mBAAmB;EAC3B,IAAI;EACJ,IAAI;EACJ,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;GAC5C,MAAM,QAAQ,aAAa;GAC3B,MAAM,YAAY,aAAa,KAAK;GACpC,IAAI,CAAC,WAAW;GAChB,SAAS;GACT,IAAI,SAAS,WAAW;GACxB,IAAI,WAAW,UAAa,mBAAmB,OAAQ,MAAM,IAAI,GAC/D,SAAS;EAEb;EACA,OAAO;CACT;AACF,CAAC;;;;;AAMD,MAAa,oBAAoB,uBAK/B;CACA,YAAY,YAAY;EACtB,MAAM,SAAS,mBAAmB,OAAO;EACzC,IAAI,SAAS,OAAO;EACpB,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,QAAQ,KACjC,IAAI,mBAAmB,OAAO,IAAK,MAAO,IAAI,GAAG,SAAS,OAAO;EAEnE,OAAO;CACT;CACA,QAAQ,EAAE,mBAAmB;EAC3B,IAAI;EACJ,IAAI;EACJ,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;GAC5C,MAAM,QAAQ,aAAa;GAC3B,MAAM,YAAY,aAAa,KAAK;GACpC,IAAI,CAAC,WAAW;GAChB,SAAS;GACT,IAAI,SAAS,WAAW;GACxB,IAAI,WAAW,UAAa,mBAAmB,OAAQ,MAAM,IAAI,GAC/D,SAAS;EAEb;EACA,OAAO;CACT;AACF,CAAC;;;;;AAMD,MAAa,uBAAuB,uBAKlC;CACA,YAAY,YAAY;EACtB,MAAM,SAAS,mBAAmB,OAAO;EACzC,IAAI,CAAC,OAAO,QAAQ,OAAO,CAAC,QAAW,MAAS;EAChD,IAAI,MAAM,OAAO;EACjB,IAAI,MAAM,OAAO;EACjB,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;GACtC,MAAM,QAAQ,OAAO;GACrB,IAAI,mBAAmB,OAAO,GAAG,IAAI,GAAG,MAAM;GAC9C,IAAI,mBAAmB,OAAO,GAAG,IAAI,GAAG,MAAM;EAChD;EACA,OAAO,CAAC,KAAK,GAAG;CAClB;CACA,QAAQ,EAAE,mBAAmB;EAC3B,IAAI,SAA2D,CAC7D,QACA,MACF;EACA,IAAI;EACJ,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;GAC5C,MAAM,SAAS,aAAa;GAC5B,MAAM,YAAY,aAAa,OAAO,EAAE;GACxC,IAAI,CAAC,WAAW;GAChB,SAAS;GACT,IAAI,SAAS,WAAW;GACxB,IAAI,OAAO,OAAO,QAChB,SAAS,CAAC,OAAO,IAAI,OAAO,EAAE;QACzB;IACL,IAAI,mBAAmB,OAAO,IAAK,OAAO,EAAE,IAAI,GAC9C,OAAO,KAAK,OAAO;IAErB,IAAI,mBAAmB,OAAO,IAAK,OAAO,EAAG,IAAI,GAC/C,OAAO,KAAK,OAAO;GAEvB;EACF;EACA,OAAO;CACT;AACF,CAAC;;;;;AAMD,MAAa,qBAAqB,uBAKhC,EACA,YAAY,YAAY;CACtB,IAAI,QAAQ;CACZ,IAAI,MAAM;CACV,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,QAAQ,KAAK;EAC5C,MAAM,QAAQ,QAAQ,SAAS,QAAQ,KAAK,EAAG;EAC/C,IAAI,SAAS,MAAM;EACnB,MAAM,cAAc,OAAO,UAAU,WAAW,QAAQ,CAAC;EACzD,IAAI,CAAC,OAAO,MAAM,WAAW,GAAG;GAC9B;GACA,OAAO;EACT;CACF;CACA,OAAO,QAAQ,MAAM,QAAQ;AAC/B,EACF,CAAC;;;;;AAMD,MAAa,uBAAuB,uBAKlC,EACA,YAAY,YAAY;CACtB,IAAI,CAAC,QAAQ,KAAK,QAAQ,OAAO;CACjC,MAAM,SAAS,IAAI,MAAc,QAAQ,KAAK,MAAM;CACpD,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,QAAQ,KAAK;EAC5C,MAAM,QAAQ,QAAQ,SAAS,QAAQ,KAAK,EAAG;EAC/C,IAAI,OAAO,UAAU,UAAU,OAAO;EACtC,OAAO,KAAK;CACd;CACA,OAAO,MAAM,GAAG,MAAM,IAAI,CAAC;CAC3B,MAAM,MAAM,KAAK,MAAM,OAAO,SAAS,CAAC;CACxC,OAAO,OAAO,SAAS,IACnB,OAAO,QACN,OAAO,MAAM,KAAM,OAAO,QAAS;AAC1C,EACF,CAAC;;AAGD,MAAa,uBAAuB,uBAKlC,EACA,YAAY,YAAY;CACtB,MAAM,yBAAS,IAAI,IAAa;CAChC,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,QAAQ,KACvC,OAAO,IAAI,QAAQ,SAAS,QAAQ,KAAK,EAAG,CAAC;CAE/C,OAAO,MAAM,KAAK,MAAM;AAC1B,EACF,CAAC;;AAGD,MAAa,4BAA4B,uBAKvC,EACA,YAAY,YAAY;CACtB,MAAM,yBAAS,IAAI,IAAa;CAChC,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK,QAAQ,KACvC,OAAO,IAAI,QAAQ,SAAS,QAAQ,KAAK,EAAG,CAAC;CAE/C,OAAO,OAAO;AAChB,EACF,CAAC;;AAGD,MAAa,sBAAsB,uBAKjC;CACA,YAAY,EAAE,WAAW,KAAK;CAC9B,QAAQ,EAAE,mBAAmB;EAC3B,IAAI,QAAQ;EACZ,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;GAC5C,MAAM,QAAQ,aAAa;GAC3B,IAAI,SAAS,KAAK,GAAG,SAAS;EAChC;EACA,OAAO;CACT;AACF,CAAC;;AAGD,MAAa,sBAAsB,uBAKjC;CACA,YAAY,YACV,QAAQ,KAAK,KAAK,QAAQ,SAAS,QAAQ,KAAK,EAAE,IAAI;CACxD,QAAQ,EAAE,mBAAmB,aAAa;AAC5C,CAAC;;AAGD,MAAa,qBAAqB,uBAKhC;CACA,YAAY,YAAY;EACtB,MAAM,MAAM,QAAQ,KAAK,QAAQ,KAAK,SAAS;EAC/C,OAAO,MAAM,QAAQ,SAAS,GAAG,IAAI;CACvC;CACA,QAAQ,EAAE,mBAAmB,aAAa,aAAa,SAAS;AAClE,CAAC;;;;;;;AAQD,MAAa,iBAAiB;CAC5B,KAAK;CACL,KAAK;CACL,KAAK;CACL,QAAQ;CACR,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,aAAa;CACb,OAAO;CACP,OAAO;CACP,MAAM;AACR"}
@@ -1,6 +1,6 @@
1
- import { CellData, OnChangeFn, RowData, Updater } from "../../types/type-utils.cjs";
1
+ import { CellData, OnChangeFn, RowData, TransformDataValueFn, Updater } from "../../types/type-utils.cjs";
2
+ import { BuiltInFilterFn } from "./filterFns.cjs";
2
3
  import { Row } from "../../types/Row.cjs";
3
- import { BuiltInFilterFn } from "../../fns/filterFns.cjs";
4
4
  import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.cjs";
5
5
  import { Column } from "../../types/Column.cjs";
6
6
  import { IsAny, TableFeatures } from "../../types/TableFeatures.cjs";
@@ -37,8 +37,48 @@ interface RowModelFns_ColumnFiltering<in out TFeatures extends TableFeatures, in
37
37
  }
38
38
  interface FilterFn<in out TFeatures extends TableFeatures, in out TData extends RowData> {
39
39
  (row: Row<TFeatures, TData>, columnId: string, filterValue: any, addMeta?: (meta: ExtractFilterMeta<TFeatures>) => void): boolean;
40
+ /**
41
+ * Removes the filter from `state.columnFilters` when the filter value fails
42
+ * this test (e.g. empty strings for text filters).
43
+ */
40
44
  autoRemove?: ColumnFilterAutoRemoveTestFn<TFeatures, TData>;
45
+ /**
46
+ * Normalizes the filter value before filtering runs.
47
+ *
48
+ * The table applies this once per filter (not per row) and passes the
49
+ * resolved value to the filter function as `filterValue`.
50
+ */
41
51
  resolveFilterValue?: TransformFilterValueFn<TFeatures, TData>;
52
+ /**
53
+ * Normalizes each row's value before it is compared against the filter
54
+ * value. Only honored by filter functions built with `constructFilterFn`
55
+ * (including all built-in filter functions).
56
+ */
57
+ resolveDataValue?: TransformDataValueFn;
58
+ }
59
+ /**
60
+ * The definition object accepted by `constructFilterFn`.
61
+ *
62
+ * `filter` is a value-level comparator: it receives the row's (resolved) data
63
+ * value and the (resolved) filter value instead of the whole row, so
64
+ * normalization concerns stay in `resolveDataValue`/`resolveFilterValue`.
65
+ */
66
+ interface FilterFnDef<in out TFeatures extends TableFeatures, in out TData extends RowData> {
67
+ filter: (dataValue: any, filterValue: any, row: Row<TFeatures, TData>, columnId: string, addMeta?: (meta: ExtractFilterMeta<TFeatures>) => void) => boolean;
68
+ autoRemove?: (filterValue: any) => boolean;
69
+ resolveFilterValue?: (filterValue: any) => any;
70
+ resolveDataValue?: TransformDataValueFn;
71
+ }
72
+ /**
73
+ * The shape returned by `constructFilterFn`: a `FilterFn` with its definition
74
+ * attached, so variants can be built by spreading it into another
75
+ * `constructFilterFn` call.
76
+ *
77
+ * The call signature is generic so a created filter function can be used with
78
+ * any table's rows, regardless of the feature set it was defined against.
79
+ */
80
+ interface CreatedFilterFn<in out TFeatures extends TableFeatures, in out TData extends RowData> extends FilterFnDef<TFeatures, TData> {
81
+ <TRowFeatures extends TableFeatures, TRowData extends RowData>(row: Row<TRowFeatures, TRowData>, columnId: string, filterValue: any, addMeta?: (meta: ExtractFilterMeta<TRowFeatures>) => void): boolean;
42
82
  }
43
83
  type TransformFilterValueFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> = (value: any, column?: Column<TFeatures, TData, TValue>) => TValue;
44
84
  type ColumnFilterAutoRemoveTestFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> = (value: any, column?: Column<TFeatures, TData, TValue>) => boolean;
@@ -170,5 +210,5 @@ interface CachedRowModel_Filtered<in out TFeatures extends TableFeatures, in out
170
210
  filteredRowModel: () => RowModel<TFeatures, TData>;
171
211
  }
172
212
  //#endregion
173
- export { CachedRowModel_Filtered, ColumnDef_ColumnFiltering, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, Column_ColumnFiltering, CustomFilterFns, ExtractFilterFnKeys, ExtractFilterMeta, FilterFn, FilterFnOption, FilterFns, FilterMeta, ResolvedColumnFilter, RowModelFns_ColumnFiltering, Row_ColumnFiltering, TableOptions_ColumnFiltering, TableState_ColumnFiltering, Table_ColumnFiltering, Table_RowModels_Filtered, TransformFilterValueFn };
213
+ export { CachedRowModel_Filtered, ColumnDef_ColumnFiltering, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, Column_ColumnFiltering, CreatedFilterFn, CustomFilterFns, ExtractFilterFnKeys, ExtractFilterMeta, FilterFn, FilterFnDef, FilterFnOption, FilterFns, FilterMeta, ResolvedColumnFilter, RowModelFns_ColumnFiltering, Row_ColumnFiltering, TableOptions_ColumnFiltering, TableState_ColumnFiltering, Table_ColumnFiltering, Table_RowModels_Filtered, TransformFilterValueFn };
174
214
  //# sourceMappingURL=columnFilteringFeature.types.d.cts.map
@@ -1,6 +1,6 @@
1
- import { CellData, OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
1
+ import { CellData, OnChangeFn, RowData, TransformDataValueFn, Updater } from "../../types/type-utils.js";
2
+ import { BuiltInFilterFn } from "./filterFns.js";
2
3
  import { Row } from "../../types/Row.js";
3
- import { BuiltInFilterFn } from "../../fns/filterFns.js";
4
4
  import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
5
5
  import { Column } from "../../types/Column.js";
6
6
  import { IsAny, TableFeatures } from "../../types/TableFeatures.js";
@@ -37,8 +37,48 @@ interface RowModelFns_ColumnFiltering<in out TFeatures extends TableFeatures, in
37
37
  }
38
38
  interface FilterFn<in out TFeatures extends TableFeatures, in out TData extends RowData> {
39
39
  (row: Row<TFeatures, TData>, columnId: string, filterValue: any, addMeta?: (meta: ExtractFilterMeta<TFeatures>) => void): boolean;
40
+ /**
41
+ * Removes the filter from `state.columnFilters` when the filter value fails
42
+ * this test (e.g. empty strings for text filters).
43
+ */
40
44
  autoRemove?: ColumnFilterAutoRemoveTestFn<TFeatures, TData>;
45
+ /**
46
+ * Normalizes the filter value before filtering runs.
47
+ *
48
+ * The table applies this once per filter (not per row) and passes the
49
+ * resolved value to the filter function as `filterValue`.
50
+ */
41
51
  resolveFilterValue?: TransformFilterValueFn<TFeatures, TData>;
52
+ /**
53
+ * Normalizes each row's value before it is compared against the filter
54
+ * value. Only honored by filter functions built with `constructFilterFn`
55
+ * (including all built-in filter functions).
56
+ */
57
+ resolveDataValue?: TransformDataValueFn;
58
+ }
59
+ /**
60
+ * The definition object accepted by `constructFilterFn`.
61
+ *
62
+ * `filter` is a value-level comparator: it receives the row's (resolved) data
63
+ * value and the (resolved) filter value instead of the whole row, so
64
+ * normalization concerns stay in `resolveDataValue`/`resolveFilterValue`.
65
+ */
66
+ interface FilterFnDef<in out TFeatures extends TableFeatures, in out TData extends RowData> {
67
+ filter: (dataValue: any, filterValue: any, row: Row<TFeatures, TData>, columnId: string, addMeta?: (meta: ExtractFilterMeta<TFeatures>) => void) => boolean;
68
+ autoRemove?: (filterValue: any) => boolean;
69
+ resolveFilterValue?: (filterValue: any) => any;
70
+ resolveDataValue?: TransformDataValueFn;
71
+ }
72
+ /**
73
+ * The shape returned by `constructFilterFn`: a `FilterFn` with its definition
74
+ * attached, so variants can be built by spreading it into another
75
+ * `constructFilterFn` call.
76
+ *
77
+ * The call signature is generic so a created filter function can be used with
78
+ * any table's rows, regardless of the feature set it was defined against.
79
+ */
80
+ interface CreatedFilterFn<in out TFeatures extends TableFeatures, in out TData extends RowData> extends FilterFnDef<TFeatures, TData> {
81
+ <TRowFeatures extends TableFeatures, TRowData extends RowData>(row: Row<TRowFeatures, TRowData>, columnId: string, filterValue: any, addMeta?: (meta: ExtractFilterMeta<TRowFeatures>) => void): boolean;
42
82
  }
43
83
  type TransformFilterValueFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> = (value: any, column?: Column<TFeatures, TData, TValue>) => TValue;
44
84
  type ColumnFilterAutoRemoveTestFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData> = (value: any, column?: Column<TFeatures, TData, TValue>) => boolean;
@@ -170,5 +210,5 @@ interface CachedRowModel_Filtered<in out TFeatures extends TableFeatures, in out
170
210
  filteredRowModel: () => RowModel<TFeatures, TData>;
171
211
  }
172
212
  //#endregion
173
- export { CachedRowModel_Filtered, ColumnDef_ColumnFiltering, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, Column_ColumnFiltering, CustomFilterFns, ExtractFilterFnKeys, ExtractFilterMeta, FilterFn, FilterFnOption, FilterFns, FilterMeta, ResolvedColumnFilter, RowModelFns_ColumnFiltering, Row_ColumnFiltering, TableOptions_ColumnFiltering, TableState_ColumnFiltering, Table_ColumnFiltering, Table_RowModels_Filtered, TransformFilterValueFn };
213
+ export { CachedRowModel_Filtered, ColumnDef_ColumnFiltering, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, Column_ColumnFiltering, CreatedFilterFn, CustomFilterFns, ExtractFilterFnKeys, ExtractFilterMeta, FilterFn, FilterFnDef, FilterFnOption, FilterFns, FilterMeta, ResolvedColumnFilter, RowModelFns_ColumnFiltering, Row_ColumnFiltering, TableOptions_ColumnFiltering, TableState_ColumnFiltering, Table_ColumnFiltering, Table_RowModels_Filtered, TransformFilterValueFn };
174
214
  //# sourceMappingURL=columnFilteringFeature.types.d.ts.map
@@ -19,8 +19,12 @@ function getDefaultColumnFiltersState() {
19
19
  * Chooses a built-in filter function from the column's first core row value.
20
20
  *
21
21
  * Strings use `includesString`, numbers use `inNumberRange`, booleans and
22
- * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
23
- * to `weakEquals`.
22
+ * objects use `equals`, dates use `inDateRange`, arrays use `arrIncludes`,
23
+ * and unknown values fall back to `weakEquals`.
24
+ *
25
+ * The chosen filter function is looked up in the table's `filterFns`
26
+ * registry. When it is not registered there, this returns `undefined` and
27
+ * warns in development instead of substituting a different filter function.
24
28
  *
25
29
  * @example
26
30
  * ```ts
@@ -31,12 +35,17 @@ function column_getAutoFilterFn(column) {
31
35
  const filterFns = column.table._rowModelFns.filterFns;
32
36
  const firstRow = column.table.getCoreRowModel().flatRows[0];
33
37
  const value = firstRow ? firstRow.getValue(column.id) : void 0;
34
- if (typeof value === "string") return filterFns?.includesString;
35
- if (typeof value === "number") return filterFns?.inNumberRange;
36
- if (typeof value === "boolean") return filterFns?.equals;
37
- if (Array.isArray(value)) return filterFns?.arrIncludes;
38
- if (value !== null && typeof value === "object") return filterFns?.equals;
39
- return filterFns?.weakEquals;
38
+ let filterFnName;
39
+ if (typeof value === "string") filterFnName = "includesString";
40
+ else if (typeof value === "number") filterFnName = "inNumberRange";
41
+ else if (typeof value === "boolean") filterFnName = "equals";
42
+ else if (Array.isArray(value)) filterFnName = "arrIncludes";
43
+ else if (Object.prototype.toString.call(value) === "[object Date]") filterFnName = "inDateRange";
44
+ else if (value !== null && typeof value === "object") filterFnName = "equals";
45
+ else filterFnName = "weakEquals";
46
+ const filterFn = filterFns?.[filterFnName];
47
+ if (process.env.NODE_ENV === "development" && !filterFn) console.warn(`filterFn '${filterFnName}' (auto) for column '${column.id}' is not registered`);
48
+ return filterFn;
40
49
  }
41
50
  /**
42
51
  * Resolves the filter function configured for a column.
@@ -54,7 +63,7 @@ function column_getFilterFn(column) {
54
63
  let filterFn = null;
55
64
  const filterFns = column.table._rowModelFns.filterFns;
56
65
  filterFn = require_utils.isFunction(column.columnDef.filterFn) ? column.columnDef.filterFn : column.columnDef.filterFn === "auto" ? column_getAutoFilterFn(column) : filterFns?.[column.columnDef.filterFn];
57
- if (process.env.NODE_ENV === "development" && !filterFn) console.warn(`Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`);
66
+ if (process.env.NODE_ENV === "development" && !filterFn && column.columnDef.filterFn !== "auto") console.warn(`filterFn '${String(column.columnDef.filterFn)}' for column '${column.id}' is not registered`);
58
67
  return filterFn ?? void 0;
59
68
  }
60
69
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"columnFilteringFeature.utils.cjs","names":["isFunction","functionalUpdate","cloneState"],"sources":["../../../src/features/column-filtering/columnFilteringFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate, isFunction } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Column_Internal } from '../../types/Column'\nimport type {\n ColumnFiltersState,\n FilterFn,\n} from './columnFilteringFeature.types'\n\n/**\n * Creates the default column filter state.\n *\n * The feature default is an empty array, meaning no column filters are active.\n * Reset APIs use this value when `defaultState` is `true`.\n *\n * @example\n * ```ts\n * const filters = getDefaultColumnFiltersState()\n * ```\n */\nexport function getDefaultColumnFiltersState(): ColumnFiltersState {\n return []\n}\n\n/**\n * Chooses a built-in filter function from the column's first core row value.\n *\n * Strings use `includesString`, numbers use `inNumberRange`, booleans and\n * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back\n * to `weakEquals`.\n *\n * @example\n * ```ts\n * const filterFn = column_getAutoFilterFn(column)\n * ```\n */\nexport function column_getAutoFilterFn<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n column.table._rowModelFns.filterFns\n\n const firstRow = column.table.getCoreRowModel().flatRows[0]\n\n const value = firstRow ? firstRow.getValue(column.id) : undefined\n\n if (typeof value === 'string') {\n return filterFns?.includesString\n }\n\n if (typeof value === 'number') {\n return filterFns?.inNumberRange\n }\n\n if (typeof value === 'boolean') {\n return filterFns?.equals\n }\n\n if (Array.isArray(value)) {\n return filterFns?.arrIncludes\n }\n\n if (value !== null && typeof value === 'object') {\n return filterFns?.equals\n }\n\n return filterFns?.weakEquals\n}\n\n/**\n * Resolves the filter function configured for a column.\n *\n * Function-valued `columnDef.filterFn` is returned directly, `'auto'` delegates\n * to `column_getAutoFilterFn`, and string values are looked up in the table's\n * filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = column_getFilterFn(column)\n * ```\n */\nexport function column_getFilterFn<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(\n column: Column_Internal<TFeatures, TData, TValue>,\n): FilterFn<TFeatures, TData> | undefined {\n let filterFn = null\n const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n column.table._rowModelFns.filterFns\n filterFn = isFunction(column.columnDef.filterFn)\n ? column.columnDef.filterFn\n : column.columnDef.filterFn === 'auto'\n ? column_getAutoFilterFn(column)\n : filterFns?.[column.columnDef.filterFn as string]\n\n if (process.env.NODE_ENV === 'development' && !filterFn) {\n console.warn(\n `Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`,\n )\n }\n\n return filterFn ?? undefined\n}\n\n/**\n * Checks whether column filtering is enabled for this accessor column.\n *\n * The column must have an accessor and filtering must be enabled by the column\n * definition, `enableColumnFilters`, and the table-wide `enableFilters` option.\n *\n * @example\n * ```ts\n * const canFilter = column_getCanFilter(column)\n * ```\n */\nexport function column_getCanFilter<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n return (\n (column.columnDef.enableColumnFilter ?? true) &&\n (column.table.options.enableColumnFilters ?? true) &&\n (column.table.options.enableFilters ?? true) &&\n !!column.accessorFn\n )\n}\n\n/**\n * Checks whether this column currently has an entry in `state.columnFilters`.\n *\n * This only reflects filter state presence; it does not indicate whether the\n * filter removes any rows.\n *\n * @example\n * ```ts\n * const isFiltered = column_getIsFiltered(column)\n * ```\n */\nexport function column_getIsFiltered<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n return column_getFilterIndex(column) > -1\n}\n\n/**\n * Reads this column's current filter value from `state.columnFilters`.\n *\n * Missing filter entries return `undefined`.\n *\n * @example\n * ```ts\n * const value = column_getFilterValue(column)\n * ```\n */\nexport function column_getFilterValue<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n return column.table.atoms.columnFilters\n ?.get()\n ?.find((d) => d.id === column.id)?.value\n}\n\n/**\n * Finds this column's position in the ordered `state.columnFilters` array.\n *\n * The result is `-1` when the column has no active filter.\n *\n * @example\n * ```ts\n * const index = column_getFilterIndex(column)\n * ```\n */\nexport function column_getFilterIndex<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n return (\n column.table.atoms.columnFilters\n ?.get()\n ?.findIndex((d) => d.id === column.id) ?? -1\n )\n}\n\n/**\n * Adds, updates, or removes this column's filter value.\n *\n * The incoming value may be an updater. After resolution, `autoRemove` rules\n * decide whether the filter should be removed instead of stored.\n *\n * @example\n * ```ts\n * column_setFilterValue(column, (old) => String(old ?? '').trim())\n * ```\n */\nexport function column_setFilterValue<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, value: any) {\n table_setColumnFilters(column.table, (old) => {\n const filterFn = column_getFilterFn(column)\n const previousFilter = old.find((d) => d.id === column.id)\n\n const newFilter = functionalUpdate(\n value,\n previousFilter ? previousFilter.value : undefined,\n )\n\n if (shouldAutoRemoveFilter(filterFn, newFilter, column)) {\n return old.filter((d) => d.id !== column.id)\n }\n\n const newFilterObj = { id: column.id, value: newFilter }\n\n if (previousFilter) {\n return old.map((d) => {\n if (d.id === column.id) {\n return newFilterObj\n }\n return d\n })\n }\n\n if (old.length) {\n return [...old, newFilterObj]\n }\n\n return [newFilterObj]\n })\n}\n\n/**\n * Routes a column filter updater through the table's filter change handler.\n *\n * The resolved filters are cleaned before they are emitted: filters for known\n * columns are removed when their filter function says the value should be\n * auto-removed.\n *\n * @example\n * ```ts\n * table_setColumnFilters(table, (old) => old.filter((filter) => filter.id !== 'age'))\n * ```\n */\nexport function table_setColumnFilters<\n TFeatures extends TableFeatures,\n TData extends RowData,\n>(\n table: Table_Internal<TFeatures, TData>,\n updater: Updater<ColumnFiltersState>,\n) {\n const leafColumnsById = table.getAllLeafColumnsById()\n\n const updateFn = (old: ColumnFiltersState) => {\n return functionalUpdate(updater, old).filter((filter) => {\n const column = leafColumnsById[filter.id]\n\n if (column) {\n const filterFn = column_getFilterFn(column)\n\n if (shouldAutoRemoveFilter(filterFn, filter.value, column)) {\n return false\n }\n }\n\n return true\n })\n }\n\n table.options.onColumnFiltersChange?.(updateFn)\n}\n\n/**\n * Resets `columnFilters` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.columnFilters` when it\n * exists. Passing `true` ignores initial state and resets to `[]`.\n *\n * @example\n * ```ts\n * table_resetColumnFilters(table)\n * table_resetColumnFilters(table, true)\n * ```\n */\nexport function table_resetColumnFilters<\n TFeatures extends TableFeatures,\n TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n table_setColumnFilters(\n table,\n defaultState ? [] : cloneState(table.initialState.columnFilters ?? []),\n )\n}\n\n/**\n * Returns whether a filter value should be removed from filter state.\n *\n * This checks the filter function's `autoRemove` hook and built-in empty-value rules.\n *\n * @example\n * ```ts\n * const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)\n * ```\n */\nexport function shouldAutoRemoveFilter<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(\n filterFn?: FilterFn<TFeatures, TData>,\n value?: any,\n column?: Column_Internal<TFeatures, TData, TValue>,\n) {\n return (\n (filterFn && filterFn.autoRemove\n ? filterFn.autoRemove(value, column as any)\n : false) ||\n typeof value === 'undefined' ||\n (typeof value === 'string' && !value)\n )\n}\n"],"mappings":";;;;;;;;;;;;;;AAqBA,SAAgB,+BAAmD;CACjE,OAAO,CAAC;AACV;;;;;;;;;;;;;AAcA,SAAgB,uBAId,QAAmD;CACnD,MAAM,YACJ,OAAO,MAAM,aAAa;CAE5B,MAAM,WAAW,OAAO,MAAM,gBAAgB,CAAC,CAAC,SAAS;CAEzD,MAAM,QAAQ,WAAW,SAAS,SAAS,OAAO,EAAE,IAAI;CAExD,IAAI,OAAO,UAAU,UACnB,OAAO,WAAW;CAGpB,IAAI,OAAO,UAAU,UACnB,OAAO,WAAW;CAGpB,IAAI,OAAO,UAAU,WACnB,OAAO,WAAW;CAGpB,IAAI,MAAM,QAAQ,KAAK,GACrB,OAAO,WAAW;CAGpB,IAAI,UAAU,QAAQ,OAAO,UAAU,UACrC,OAAO,WAAW;CAGpB,OAAO,WAAW;AACpB;;;;;;;;;;;;;AAcA,SAAgB,mBAKd,QACwC;CACxC,IAAI,WAAW;CACf,MAAM,YACJ,OAAO,MAAM,aAAa;CAC5B,WAAWA,yBAAW,OAAO,UAAU,QAAQ,IAC3C,OAAO,UAAU,WACjB,OAAO,UAAU,aAAa,SAC5B,uBAAuB,MAAM,IAC7B,YAAY,OAAO,UAAU;CAEnC,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,UAC7C,QAAQ,KACN,oEAAoE,OAAO,GAAG,EAChF;CAGF,OAAO,YAAY;AACrB;;;;;;;;;;;;AAaA,SAAgB,oBAId,QAAmD;CACnD,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,uBAAuB,UAC5C,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;AAEb;;;;;;;;;;;;AAaA,SAAgB,qBAId,QAAmD;CACnD,OAAO,sBAAsB,MAAM,IAAI;AACzC;;;;;;;;;;;AAYA,SAAgB,sBAId,QAAmD;CACnD,OAAO,OAAO,MAAM,MAAM,eACtB,IAAI,CAAC,EACL,MAAM,MAAM,EAAE,OAAO,OAAO,EAAE,CAAC,EAAE;AACvC;;;;;;;;;;;AAYA,SAAgB,sBAId,QAA2D;CAC3D,OACE,OAAO,MAAM,MAAM,eACf,IAAI,CAAC,EACL,WAAW,MAAM,EAAE,OAAO,OAAO,EAAE,KAAK;AAEhD;;;;;;;;;;;;AAaA,SAAgB,sBAId,QAAmD,OAAY;CAC/D,uBAAuB,OAAO,QAAQ,QAAQ;EAC5C,MAAM,WAAW,mBAAmB,MAAM;EAC1C,MAAM,iBAAiB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,EAAE;EAEzD,MAAM,YAAYC,+BAChB,OACA,iBAAiB,eAAe,QAAQ,MAC1C;EAEA,IAAI,uBAAuB,UAAU,WAAW,MAAM,GACpD,OAAO,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,EAAE;EAG7C,MAAM,eAAe;GAAE,IAAI,OAAO;GAAI,OAAO;EAAU;EAEvD,IAAI,gBACF,OAAO,IAAI,KAAK,MAAM;GACpB,IAAI,EAAE,OAAO,OAAO,IAClB,OAAO;GAET,OAAO;EACT,CAAC;EAGH,IAAI,IAAI,QACN,OAAO,CAAC,GAAG,KAAK,YAAY;EAG9B,OAAO,CAAC,YAAY;CACtB,CAAC;AACH;;;;;;;;;;;;;AAcA,SAAgB,uBAId,OACA,SACA;CACA,MAAM,kBAAkB,MAAM,sBAAsB;CAEpD,MAAM,YAAY,QAA4B;EAC5C,OAAOA,+BAAiB,SAAS,GAAG,CAAC,CAAC,QAAQ,WAAW;GACvD,MAAM,SAAS,gBAAgB,OAAO;GAEtC,IAAI,QAGF;QAAI,uBAFa,mBAAmB,MAEF,GAAG,OAAO,OAAO,MAAM,GACvD,OAAO;GACT;GAGF,OAAO;EACT,CAAC;CACH;CAEA,MAAM,QAAQ,wBAAwB,QAAQ;AAChD;;;;;;;;;;;;;AAcA,SAAgB,yBAGd,OAAyC,cAAwB;CACjE,uBACE,OACA,eAAe,CAAC,IAAIC,yBAAW,MAAM,aAAa,iBAAiB,CAAC,CAAC,CACvE;AACF;;;;;;;;;;;AAYA,SAAgB,uBAKd,UACA,OACA,QACA;CACA,QACG,YAAY,SAAS,aAClB,SAAS,WAAW,OAAO,MAAa,IACxC,UACJ,OAAO,UAAU,eAChB,OAAO,UAAU,YAAY,CAAC;AAEnC"}
1
+ {"version":3,"file":"columnFilteringFeature.utils.cjs","names":["isFunction","functionalUpdate","cloneState"],"sources":["../../../src/features/column-filtering/columnFilteringFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate, isFunction } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Column_Internal } from '../../types/Column'\nimport type {\n ColumnFiltersState,\n FilterFn,\n} from './columnFilteringFeature.types'\n\n/**\n * Creates the default column filter state.\n *\n * The feature default is an empty array, meaning no column filters are active.\n * Reset APIs use this value when `defaultState` is `true`.\n *\n * @example\n * ```ts\n * const filters = getDefaultColumnFiltersState()\n * ```\n */\nexport function getDefaultColumnFiltersState(): ColumnFiltersState {\n return []\n}\n\n/**\n * Chooses a built-in filter function from the column's first core row value.\n *\n * Strings use `includesString`, numbers use `inNumberRange`, booleans and\n * objects use `equals`, dates use `inDateRange`, arrays use `arrIncludes`,\n * and unknown values fall back to `weakEquals`.\n *\n * The chosen filter function is looked up in the table's `filterFns`\n * registry. When it is not registered there, this returns `undefined` and\n * warns in development instead of substituting a different filter function.\n *\n * @example\n * ```ts\n * const filterFn = column_getAutoFilterFn(column)\n * ```\n */\nexport function column_getAutoFilterFn<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n column.table._rowModelFns.filterFns\n\n const firstRow = column.table.getCoreRowModel().flatRows[0]\n\n const value = firstRow ? firstRow.getValue(column.id) : undefined\n\n let filterFnName: string\n\n if (typeof value === 'string') {\n filterFnName = 'includesString'\n } else if (typeof value === 'number') {\n filterFnName = 'inNumberRange'\n } else if (typeof value === 'boolean') {\n filterFnName = 'equals'\n } else if (Array.isArray(value)) {\n filterFnName = 'arrIncludes'\n } else if (Object.prototype.toString.call(value) === '[object Date]') {\n filterFnName = 'inDateRange'\n } else if (value !== null && typeof value === 'object') {\n filterFnName = 'equals'\n } else {\n filterFnName = 'weakEquals'\n }\n\n const filterFn = filterFns?.[filterFnName]\n\n if (process.env.NODE_ENV === 'development' && !filterFn) {\n console.warn(\n `filterFn '${filterFnName}' (auto) for column '${column.id}' is not registered`,\n )\n }\n\n return filterFn\n}\n\n/**\n * Resolves the filter function configured for a column.\n *\n * Function-valued `columnDef.filterFn` is returned directly, `'auto'` delegates\n * to `column_getAutoFilterFn`, and string values are looked up in the table's\n * filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = column_getFilterFn(column)\n * ```\n */\nexport function column_getFilterFn<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(\n column: Column_Internal<TFeatures, TData, TValue>,\n): FilterFn<TFeatures, TData> | undefined {\n let filterFn = null\n const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n column.table._rowModelFns.filterFns\n filterFn = isFunction(column.columnDef.filterFn)\n ? column.columnDef.filterFn\n : column.columnDef.filterFn === 'auto'\n ? column_getAutoFilterFn(column)\n : filterFns?.[column.columnDef.filterFn as string]\n\n if (\n process.env.NODE_ENV === 'development' &&\n !filterFn &&\n column.columnDef.filterFn !== 'auto' // the auto picker warns on its own\n ) {\n console.warn(\n `filterFn '${String(column.columnDef.filterFn)}' for column '${column.id}' is not registered`,\n )\n }\n\n return filterFn ?? undefined\n}\n\n/**\n * Checks whether column filtering is enabled for this accessor column.\n *\n * The column must have an accessor and filtering must be enabled by the column\n * definition, `enableColumnFilters`, and the table-wide `enableFilters` option.\n *\n * @example\n * ```ts\n * const canFilter = column_getCanFilter(column)\n * ```\n */\nexport function column_getCanFilter<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n return (\n (column.columnDef.enableColumnFilter ?? true) &&\n (column.table.options.enableColumnFilters ?? true) &&\n (column.table.options.enableFilters ?? true) &&\n !!column.accessorFn\n )\n}\n\n/**\n * Checks whether this column currently has an entry in `state.columnFilters`.\n *\n * This only reflects filter state presence; it does not indicate whether the\n * filter removes any rows.\n *\n * @example\n * ```ts\n * const isFiltered = column_getIsFiltered(column)\n * ```\n */\nexport function column_getIsFiltered<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n return column_getFilterIndex(column) > -1\n}\n\n/**\n * Reads this column's current filter value from `state.columnFilters`.\n *\n * Missing filter entries return `undefined`.\n *\n * @example\n * ```ts\n * const value = column_getFilterValue(column)\n * ```\n */\nexport function column_getFilterValue<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n return column.table.atoms.columnFilters\n ?.get()\n ?.find((d) => d.id === column.id)?.value\n}\n\n/**\n * Finds this column's position in the ordered `state.columnFilters` array.\n *\n * The result is `-1` when the column has no active filter.\n *\n * @example\n * ```ts\n * const index = column_getFilterIndex(column)\n * ```\n */\nexport function column_getFilterIndex<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n return (\n column.table.atoms.columnFilters\n ?.get()\n ?.findIndex((d) => d.id === column.id) ?? -1\n )\n}\n\n/**\n * Adds, updates, or removes this column's filter value.\n *\n * The incoming value may be an updater. After resolution, `autoRemove` rules\n * decide whether the filter should be removed instead of stored.\n *\n * @example\n * ```ts\n * column_setFilterValue(column, (old) => String(old ?? '').trim())\n * ```\n */\nexport function column_setFilterValue<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, value: any) {\n table_setColumnFilters(column.table, (old) => {\n const filterFn = column_getFilterFn(column)\n const previousFilter = old.find((d) => d.id === column.id)\n\n const newFilter = functionalUpdate(\n value,\n previousFilter ? previousFilter.value : undefined,\n )\n\n if (shouldAutoRemoveFilter(filterFn, newFilter, column)) {\n return old.filter((d) => d.id !== column.id)\n }\n\n const newFilterObj = { id: column.id, value: newFilter }\n\n if (previousFilter) {\n return old.map((d) => {\n if (d.id === column.id) {\n return newFilterObj\n }\n return d\n })\n }\n\n if (old.length) {\n return [...old, newFilterObj]\n }\n\n return [newFilterObj]\n })\n}\n\n/**\n * Routes a column filter updater through the table's filter change handler.\n *\n * The resolved filters are cleaned before they are emitted: filters for known\n * columns are removed when their filter function says the value should be\n * auto-removed.\n *\n * @example\n * ```ts\n * table_setColumnFilters(table, (old) => old.filter((filter) => filter.id !== 'age'))\n * ```\n */\nexport function table_setColumnFilters<\n TFeatures extends TableFeatures,\n TData extends RowData,\n>(\n table: Table_Internal<TFeatures, TData>,\n updater: Updater<ColumnFiltersState>,\n) {\n const leafColumnsById = table.getAllLeafColumnsById()\n\n const updateFn = (old: ColumnFiltersState) => {\n return functionalUpdate(updater, old).filter((filter) => {\n const column = leafColumnsById[filter.id]\n\n if (column) {\n const filterFn = column_getFilterFn(column)\n\n if (shouldAutoRemoveFilter(filterFn, filter.value, column)) {\n return false\n }\n }\n\n return true\n })\n }\n\n table.options.onColumnFiltersChange?.(updateFn)\n}\n\n/**\n * Resets `columnFilters` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.columnFilters` when it\n * exists. Passing `true` ignores initial state and resets to `[]`.\n *\n * @example\n * ```ts\n * table_resetColumnFilters(table)\n * table_resetColumnFilters(table, true)\n * ```\n */\nexport function table_resetColumnFilters<\n TFeatures extends TableFeatures,\n TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n table_setColumnFilters(\n table,\n defaultState ? [] : cloneState(table.initialState.columnFilters ?? []),\n )\n}\n\n/**\n * Returns whether a filter value should be removed from filter state.\n *\n * This checks the filter function's `autoRemove` hook and built-in empty-value rules.\n *\n * @example\n * ```ts\n * const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)\n * ```\n */\nexport function shouldAutoRemoveFilter<\n TFeatures extends TableFeatures,\n TData extends RowData,\n TValue extends CellData = CellData,\n>(\n filterFn?: FilterFn<TFeatures, TData>,\n value?: any,\n column?: Column_Internal<TFeatures, TData, TValue>,\n) {\n return (\n (filterFn && filterFn.autoRemove\n ? filterFn.autoRemove(value, column as any)\n : false) ||\n typeof value === 'undefined' ||\n (typeof value === 'string' && !value)\n )\n}\n"],"mappings":";;;;;;;;;;;;;;AAqBA,SAAgB,+BAAmD;CACjE,OAAO,CAAC;AACV;;;;;;;;;;;;;;;;;AAkBA,SAAgB,uBAId,QAAmD;CACnD,MAAM,YACJ,OAAO,MAAM,aAAa;CAE5B,MAAM,WAAW,OAAO,MAAM,gBAAgB,CAAC,CAAC,SAAS;CAEzD,MAAM,QAAQ,WAAW,SAAS,SAAS,OAAO,EAAE,IAAI;CAExD,IAAI;CAEJ,IAAI,OAAO,UAAU,UACnB,eAAe;MACV,IAAI,OAAO,UAAU,UAC1B,eAAe;MACV,IAAI,OAAO,UAAU,WAC1B,eAAe;MACV,IAAI,MAAM,QAAQ,KAAK,GAC5B,eAAe;MACV,IAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM,iBACnD,eAAe;MACV,IAAI,UAAU,QAAQ,OAAO,UAAU,UAC5C,eAAe;MAEf,eAAe;CAGjB,MAAM,WAAW,YAAY;CAE7B,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,UAC7C,QAAQ,KACN,aAAa,aAAa,uBAAuB,OAAO,GAAG,oBAC7D;CAGF,OAAO;AACT;;;;;;;;;;;;;AAcA,SAAgB,mBAKd,QACwC;CACxC,IAAI,WAAW;CACf,MAAM,YACJ,OAAO,MAAM,aAAa;CAC5B,WAAWA,yBAAW,OAAO,UAAU,QAAQ,IAC3C,OAAO,UAAU,WACjB,OAAO,UAAU,aAAa,SAC5B,uBAAuB,MAAM,IAC7B,YAAY,OAAO,UAAU;CAEnC,IACE,QAAQ,IAAI,aAAa,iBACzB,CAAC,YACD,OAAO,UAAU,aAAa,QAE9B,QAAQ,KACN,aAAa,OAAO,OAAO,UAAU,QAAQ,EAAE,gBAAgB,OAAO,GAAG,oBAC3E;CAGF,OAAO,YAAY;AACrB;;;;;;;;;;;;AAaA,SAAgB,oBAId,QAAmD;CACnD,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,uBAAuB,UAC5C,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;AAEb;;;;;;;;;;;;AAaA,SAAgB,qBAId,QAAmD;CACnD,OAAO,sBAAsB,MAAM,IAAI;AACzC;;;;;;;;;;;AAYA,SAAgB,sBAId,QAAmD;CACnD,OAAO,OAAO,MAAM,MAAM,eACtB,IAAI,CAAC,EACL,MAAM,MAAM,EAAE,OAAO,OAAO,EAAE,CAAC,EAAE;AACvC;;;;;;;;;;;AAYA,SAAgB,sBAId,QAA2D;CAC3D,OACE,OAAO,MAAM,MAAM,eACf,IAAI,CAAC,EACL,WAAW,MAAM,EAAE,OAAO,OAAO,EAAE,KAAK;AAEhD;;;;;;;;;;;;AAaA,SAAgB,sBAId,QAAmD,OAAY;CAC/D,uBAAuB,OAAO,QAAQ,QAAQ;EAC5C,MAAM,WAAW,mBAAmB,MAAM;EAC1C,MAAM,iBAAiB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,EAAE;EAEzD,MAAM,YAAYC,+BAChB,OACA,iBAAiB,eAAe,QAAQ,MAC1C;EAEA,IAAI,uBAAuB,UAAU,WAAW,MAAM,GACpD,OAAO,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,EAAE;EAG7C,MAAM,eAAe;GAAE,IAAI,OAAO;GAAI,OAAO;EAAU;EAEvD,IAAI,gBACF,OAAO,IAAI,KAAK,MAAM;GACpB,IAAI,EAAE,OAAO,OAAO,IAClB,OAAO;GAET,OAAO;EACT,CAAC;EAGH,IAAI,IAAI,QACN,OAAO,CAAC,GAAG,KAAK,YAAY;EAG9B,OAAO,CAAC,YAAY;CACtB,CAAC;AACH;;;;;;;;;;;;;AAcA,SAAgB,uBAId,OACA,SACA;CACA,MAAM,kBAAkB,MAAM,sBAAsB;CAEpD,MAAM,YAAY,QAA4B;EAC5C,OAAOA,+BAAiB,SAAS,GAAG,CAAC,CAAC,QAAQ,WAAW;GACvD,MAAM,SAAS,gBAAgB,OAAO;GAEtC,IAAI,QAGF;QAAI,uBAFa,mBAAmB,MAEF,GAAG,OAAO,OAAO,MAAM,GACvD,OAAO;GACT;GAGF,OAAO;EACT,CAAC;CACH;CAEA,MAAM,QAAQ,wBAAwB,QAAQ;AAChD;;;;;;;;;;;;;AAcA,SAAgB,yBAGd,OAAyC,cAAwB;CACjE,uBACE,OACA,eAAe,CAAC,IAAIC,yBAAW,MAAM,aAAa,iBAAiB,CAAC,CAAC,CACvE;AACF;;;;;;;;;;;AAYA,SAAgB,uBAKd,UACA,OACA,QACA;CACA,QACG,YAAY,SAAS,aAClB,SAAS,WAAW,OAAO,MAAa,IACxC,UACJ,OAAO,UAAU,eAChB,OAAO,UAAU,YAAY,CAAC;AAEnC"}
@@ -21,8 +21,12 @@ declare function getDefaultColumnFiltersState(): ColumnFiltersState;
21
21
  * Chooses a built-in filter function from the column's first core row value.
22
22
  *
23
23
  * Strings use `includesString`, numbers use `inNumberRange`, booleans and
24
- * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
25
- * to `weakEquals`.
24
+ * objects use `equals`, dates use `inDateRange`, arrays use `arrIncludes`,
25
+ * and unknown values fall back to `weakEquals`.
26
+ *
27
+ * The chosen filter function is looked up in the table's `filterFns`
28
+ * registry. When it is not registered there, this returns `undefined` and
29
+ * warns in development instead of substituting a different filter function.
26
30
  *
27
31
  * @example
28
32
  * ```ts
@@ -21,8 +21,12 @@ declare function getDefaultColumnFiltersState(): ColumnFiltersState;
21
21
  * Chooses a built-in filter function from the column's first core row value.
22
22
  *
23
23
  * Strings use `includesString`, numbers use `inNumberRange`, booleans and
24
- * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
25
- * to `weakEquals`.
24
+ * objects use `equals`, dates use `inDateRange`, arrays use `arrIncludes`,
25
+ * and unknown values fall back to `weakEquals`.
26
+ *
27
+ * The chosen filter function is looked up in the table's `filterFns`
28
+ * registry. When it is not registered there, this returns `undefined` and
29
+ * warns in development instead of substituting a different filter function.
26
30
  *
27
31
  * @example
28
32
  * ```ts
@@ -19,8 +19,12 @@ function getDefaultColumnFiltersState() {
19
19
  * Chooses a built-in filter function from the column's first core row value.
20
20
  *
21
21
  * Strings use `includesString`, numbers use `inNumberRange`, booleans and
22
- * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
23
- * to `weakEquals`.
22
+ * objects use `equals`, dates use `inDateRange`, arrays use `arrIncludes`,
23
+ * and unknown values fall back to `weakEquals`.
24
+ *
25
+ * The chosen filter function is looked up in the table's `filterFns`
26
+ * registry. When it is not registered there, this returns `undefined` and
27
+ * warns in development instead of substituting a different filter function.
24
28
  *
25
29
  * @example
26
30
  * ```ts
@@ -31,12 +35,17 @@ function column_getAutoFilterFn(column) {
31
35
  const filterFns = column.table._rowModelFns.filterFns;
32
36
  const firstRow = column.table.getCoreRowModel().flatRows[0];
33
37
  const value = firstRow ? firstRow.getValue(column.id) : void 0;
34
- if (typeof value === "string") return filterFns?.includesString;
35
- if (typeof value === "number") return filterFns?.inNumberRange;
36
- if (typeof value === "boolean") return filterFns?.equals;
37
- if (Array.isArray(value)) return filterFns?.arrIncludes;
38
- if (value !== null && typeof value === "object") return filterFns?.equals;
39
- return filterFns?.weakEquals;
38
+ let filterFnName;
39
+ if (typeof value === "string") filterFnName = "includesString";
40
+ else if (typeof value === "number") filterFnName = "inNumberRange";
41
+ else if (typeof value === "boolean") filterFnName = "equals";
42
+ else if (Array.isArray(value)) filterFnName = "arrIncludes";
43
+ else if (Object.prototype.toString.call(value) === "[object Date]") filterFnName = "inDateRange";
44
+ else if (value !== null && typeof value === "object") filterFnName = "equals";
45
+ else filterFnName = "weakEquals";
46
+ const filterFn = filterFns?.[filterFnName];
47
+ if (process.env.NODE_ENV === "development" && !filterFn) console.warn(`filterFn '${filterFnName}' (auto) for column '${column.id}' is not registered`);
48
+ return filterFn;
40
49
  }
41
50
  /**
42
51
  * Resolves the filter function configured for a column.
@@ -54,7 +63,7 @@ function column_getFilterFn(column) {
54
63
  let filterFn = null;
55
64
  const filterFns = column.table._rowModelFns.filterFns;
56
65
  filterFn = isFunction(column.columnDef.filterFn) ? column.columnDef.filterFn : column.columnDef.filterFn === "auto" ? column_getAutoFilterFn(column) : filterFns?.[column.columnDef.filterFn];
57
- if (process.env.NODE_ENV === "development" && !filterFn) console.warn(`Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`);
66
+ if (process.env.NODE_ENV === "development" && !filterFn && column.columnDef.filterFn !== "auto") console.warn(`filterFn '${String(column.columnDef.filterFn)}' for column '${column.id}' is not registered`);
58
67
  return filterFn ?? void 0;
59
68
  }
60
69
  /**