-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathtable.ts
More file actions
226 lines (202 loc) · 6.82 KB
/
table.ts
File metadata and controls
226 lines (202 loc) · 6.82 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
import { ColumnData } from "@/types/shared";
import { ColumnDef } from "@tanstack/react-table";
import TypeHeader from "@/components/shared/DataTableHeaders/TypeHeader";
import TextCell from "@/components/shared/DataTableCells/TextCell";
export const sortColumnsByOrder = <TColumnData>(
columns: ColumnData<TColumnData>[],
order?: string[],
) => {
if (!order || order.length === 0) return columns;
const orderMap = order.reduce<Record<string, number>>((acc, id, index) => {
acc[id] = index;
return acc;
}, {});
return columns
.slice()
.sort((c1, c2) => (orderMap[c1.id] ?? 0) - (orderMap[c2.id] ?? 0));
};
export const hasAnyVisibleColumns = <TColumnData>(
columns: ColumnData<TColumnData>[],
selectedColumns: string[],
) => columns.some(({ id }) => selectedColumns.includes(id));
/**
* Migrates selected columns from an old localStorage key.
* Returns the migrated value to be persisted by the caller.
*
* @param oldStorageKey - The old localStorage key to migrate from
* @param defaultColumns - Default columns to use if no stored data exists
* @param columnsToAdd - Columns to add during migration
* @returns The selected columns array
*/
export const migrateSelectedColumns = (
oldStorageKey: string,
defaultColumns: string[],
columnsToAdd: string[] = [],
): string[] => {
const oldData = localStorage.getItem(oldStorageKey);
if (oldData !== null) {
const oldColumns = JSON.parse(oldData);
return [...new Set([...oldColumns, ...columnsToAdd])];
}
return defaultColumns;
};
/**
* Migrates column order from an old localStorage key.
* Preserves custom user orders (non-empty arrays) and applies
* the new default order for users who never customized.
*/
export const migrateColumnsOrder = (
oldStorageKey: string,
defaultOrder: string[],
): string[] => {
const oldData = localStorage.getItem(oldStorageKey);
if (oldData !== null) {
const parsed = JSON.parse(oldData);
if (Array.isArray(parsed) && parsed.length > 0) {
return parsed;
}
}
return defaultOrder;
};
/**
* Determines if a column can be sorted based on the backend's sortable_by response.
* Handles multiple matching patterns:
* 1. Direct match: column id exactly matches a sortable field
* 2. Wildcard match: "data.*" allows sorting any field under "data." prefix
* 3. Legacy single field: fields without dots that match wildcard patterns
* 4. Prefix match: "output.field" matches if "output" is sortable
*
* @param id - The column identifier (e.g., "id", "data.field", "output.result")
* @param sortableColumns - Array of sortable field patterns from backend
* @returns true if the column can be sorted
*/
export const isColumnSortable = (id: string, sortableColumns: string[]) => {
// Direct match: exact field name is sortable
if (sortableColumns.includes(id)) return true;
const keys = id.split(".");
// Wildcard pattern match: e.g., "data.*" allows "data.field"
if (keys.length > 1 && sortableColumns.includes(`${keys[0]}.*`)) {
return true;
}
if (keys.length > 1 && sortableColumns.includes(keys[0])) {
return true;
}
return false;
};
export const convertColumnDataToColumn = <TColumnData, TData>(
columns: ColumnData<TColumnData>[],
{
columnsOrder = [],
selectedColumns,
sortableColumns = [],
}: {
columnsOrder?: string[];
selectedColumns?: string[];
sortableColumns?: string[];
},
) => {
const retVal: ColumnDef<TData>[] = [];
sortColumnsByOrder(columns, columnsOrder).forEach((column) => {
const isSelected = selectedColumns
? selectedColumns.includes(column.id)
: true;
if (isSelected) {
// If column explicitly sets sortable to false, respect that
// Otherwise, check if backend supports sorting
const shouldEnableSorting =
column.sortable !== false &&
Boolean(sortableColumns?.length) &&
isColumnSortable(column.id, sortableColumns);
retVal.push(
mapColumnDataFields({
...column,
sortable: shouldEnableSorting,
}),
);
}
});
return retVal;
};
export const mapColumnDataFields = <TColumnData, TData>(
columnData: ColumnData<TColumnData>,
): ColumnDef<TData> => {
return {
...(columnData.accessorFn && { accessorFn: columnData.accessorFn }),
accessorKey: columnData.id,
header: (columnData.header ?? TypeHeader) as never,
meta: {
type: columnData.type,
header: columnData.label,
headerCheckbox: columnData.headerCheckbox,
iconType: columnData.iconType,
statisticKey: columnData.statisticKey || columnData.id,
...(columnData.statisticDataFormater && {
statisticDataFormater: columnData.statisticDataFormater,
}),
...(columnData.statisticTooltipFormater && {
statisticTooltipFormater: columnData.statisticTooltipFormater,
}),
...(columnData.supportsPercentiles !== undefined && {
supportsPercentiles: columnData.supportsPercentiles,
}),
...(columnData.verticalAlignment && {
verticalAlignment: columnData.verticalAlignment,
}),
...(columnData.overrideRowHeight && {
overrideRowHeight: columnData.overrideRowHeight,
}),
...(columnData.explainer && {
explainer: columnData.explainer,
}),
...(columnData.customMeta && { custom: columnData.customMeta }),
},
...(columnData.size && { size: columnData.size }),
...(columnData.minSize && { minSize: columnData.minSize }),
cell: (columnData.cell ?? TextCell) as never,
...(columnData.aggregatedCell && {
aggregatedCell: columnData.aggregatedCell as never,
}),
enableSorting: columnData.sortable || false,
};
};
/**
* Injects a callback into a column's custom metadata.
* Useful for adding dynamic row click handlers to columns that need to be editable via the columns menu.
*
* @param columns - Array of column definitions
* @param columnId - ID of the column to inject the callback into
* @param callback - The callback function to inject
* @param additionalMeta - Optional additional metadata to merge
* @returns The modified columns array
*/
export const injectColumnCallback = <TData>(
columns: ColumnDef<TData>[],
columnId: string,
callback: (row: TData) => void,
additionalMeta?: Record<string, unknown>,
): ColumnDef<TData>[] => {
const columnIndex = columns.findIndex((col) => {
const column = col as { accessorKey?: string };
return column.accessorKey === columnId;
});
if (columnIndex === -1) {
return columns;
}
const targetColumn = columns[columnIndex];
const updatedColumn: ColumnDef<TData> = {
...targetColumn,
meta: {
...targetColumn.meta,
custom: {
...targetColumn.meta?.custom,
callback,
...additionalMeta,
},
},
};
return [
...columns.slice(0, columnIndex),
updatedColumn,
...columns.slice(columnIndex + 1),
];
};