-
Notifications
You must be signed in to change notification settings - Fork 480
/
table.ts
253 lines (234 loc) · 7.47 KB
/
table.ts
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
import { atom } from "jotai";
import { atomWithReducer, atomWithHash } from "jotai/utils";
import { findIndex, cloneDeep, unset, orderBy } from "lodash-es";
import {
TableSettings,
TableSchema,
ColumnConfig,
TableFilter,
TableSort,
TableRow,
UpdateDocFunction,
UpdateCollectionDocFunction,
DeleteCollectionDocFunction,
NextPageState,
BulkWriteFunction,
} from "@src/types/table";
import { updateRowData } from "@src/utils/table";
import { Table } from "@tanstack/react-table";
/** Root atom from which others are derived */
export const tableIdAtom = atom("");
/** Store tableSettings from project settings document */
export const tableSettingsAtom = atom<TableSettings>({
id: "",
collection: "",
name: "",
roles: [],
section: "",
tableType: "primaryCollection",
});
/** Store tableSchema from schema document */
export const tableSchemaAtom = atom<TableSchema>({});
/** Store function to update tableSchema */
export const updateTableSchemaAtom = atom<
UpdateDocFunction<TableSchema> | undefined
>(undefined);
/**
* Store the table columns as an ordered array.
* Puts frozen columns at the start, then sorts by ascending index.
*/
export const tableColumnsOrderedAtom = atom<ColumnConfig[]>((get) => {
const tableSchema = get(tableSchemaAtom);
if (!tableSchema || !tableSchema.columns) return [];
return orderBy(
Object.values(tableSchema?.columns ?? {}),
[(c) => Boolean(c.fixed), "index"],
["desc", "asc"]
);
});
/** Store the table */
export const reactTableAtom = atom<Table<TableRow> | null>(null);
/** Reducer function to convert from array of columns to columns object */
export const tableColumnsReducer = (
a: Record<string, ColumnConfig>,
c: ColumnConfig,
index: number
) => {
a[c.key] = { ...c, index };
return a;
};
/** Filters applied to the local view */
export const tableFiltersAtom = atom<TableFilter[]>([]);
/** Join operator applied to mulitple filters */
export const tableFiltersJoinAtom = atom<"AND" | "OR">("AND");
/** Sorts applied to the local view */
export const tableSortsAtom = atom<TableSort[]>([]);
/** Store current page in URL */
export const tablePageHashAtom = atomWithHash("page", 0, {
replaceState: true,
});
/**
* Set the page for the table query. Stops updating if we’ve loaded all rows.
*/
export const tablePageAtom = atom(
(get) => get(tablePageHashAtom),
(get, set, update: number | ((p: number) => number)) => {
// If loading more or doesn’t have next page, don’t request another page
const tableNextPage = get(tableNextPageAtom);
if (tableNextPage.loading || !tableNextPage.available) return;
const currentPage = get(tablePageHashAtom);
set(
tablePageHashAtom,
typeof update === "number" ? update : update(currentPage)
);
}
);
type TableRowsLocalAction =
/** Overwrite all rows */
| { type: "set"; rows: TableRow[] }
/** Add a row or multiple rows */
| { type: "add"; row: TableRow | TableRow[] }
/** Update a row */
| {
type: "update";
path: string;
row: Partial<TableRow>;
deleteFields?: string[];
}
/** Delete a row or multiple rows */
| { type: "delete"; path: string | string[] };
const tableRowsLocalReducer = (
prev: TableRow[],
action: TableRowsLocalAction
): TableRow[] => {
switch (action.type) {
case "set":
return [...action.rows];
case "add":
if (Array.isArray(action.row)) return [...action.row, ...prev];
return [action.row, ...prev];
case "update":
const index = findIndex(prev, ["_rowy_ref.path", action.path]);
if (index > -1) {
const updatedRows = [...prev];
updatedRows[index] = cloneDeep(prev[index]);
if (Array.isArray(action.deleteFields)) {
for (const field of action.deleteFields) {
unset(updatedRows[index], field);
}
}
updatedRows[index] = updateRowData(updatedRows[index], action.row);
return updatedRows;
}
// If not found, add to start
else {
return [
{
...action.row,
_rowy_ref: {
path: action.path,
id: action.path.split("/").pop() || action.path,
},
},
...prev,
];
}
case "delete":
return prev.filter((row) => {
if (Array.isArray(action.path)) {
return !action.path.includes(row._rowy_ref.path);
} else {
return row._rowy_ref.path !== action.path;
}
});
default:
throw new Error("Invalid action");
}
};
/**
* Store rows that are out of order or not ready to be written to the db.
* See {@link TableRowsLocalAction} for reducer actions.
*/
export const tableRowsLocalAtom = atomWithReducer(
[] as TableRow[],
tableRowsLocalReducer
);
/** Store rows from the db listener */
export const tableRowsDbAtom = atom<TableRow[]>([]);
/** Combine tableRowsLocal and tableRowsDb */
export const tableRowsAtom = atom<TableRow[]>((get) => {
const rowsDb = get(tableRowsDbAtom);
const rowsLocal = get(tableRowsLocalAtom);
// Optimization: create Map of rowsDb by path to index for faster lookup
const rowsDbMap = new Map<string, number>();
rowsDb.forEach((row, i) => rowsDbMap.set(row._rowy_ref.path, i));
// Loop through rowsLocal, which is usually the smaller of the two arrays
const rowsLocalToMerge = rowsLocal.map((row, i) => {
// If row is in rowsDb, merge the two
// and remove from rowsDb to prevent duplication
if (rowsDbMap.has(row._rowy_ref.path)) {
const index = rowsDbMap.get(row._rowy_ref.path)!;
const merged = updateRowData({ ...rowsDb[index] }, row);
rowsDbMap.delete(row._rowy_ref.path);
return merged;
}
return row;
});
// Merge the two arrays
return [
...rowsLocalToMerge,
...rowsDb.filter((row) => rowsDbMap.has(row._rowy_ref.path)),
];
});
/** Store next page state for infinite scroll */
export const tableNextPageAtom = atom({
loading: false,
available: true,
} as NextPageState);
/**
* Store function to add or update row in db directly.
* Has same behaviour as Firestore setDoc with merge.
* @see
* - {@link updateRowData} implementation
* - https://stackoverflow.com/a/47554197/3572007
* @internal Use {@link addRowAtom} or {@link updateRowAtom} instead
*/
export const _updateRowDbAtom = atom<UpdateCollectionDocFunction | undefined>(
undefined
);
/**
* Store function to delete row in db directly
* @internal Use {@link deleteRowAtom} instead
*/
export const _deleteRowDbAtom = atom<DeleteCollectionDocFunction | undefined>(
undefined
);
/**
* Store function to bulk write to db
* @internal Use {@link bulkAddRowsAtom} instead
*/
export const _bulkWriteDbAtom = atom<BulkWriteFunction | undefined>(undefined);
export type AuditChangeFunction = (
type: "ADD_ROW" | "UPDATE_CELL" | "DELETE_ROW",
rowId: string,
data?:
| {
updatedField?: string | undefined;
}
| undefined
) => Promise<any>;
/**
* Store function to write auditing logs when user makes changes to the table.
* Silently fails if auditing is disabled for the table or Rowy Run version
* not compatible.
*
* @param type - Action type: "ADD_ROW" | "UPDATE_CELL" | "DELETE_ROW"
* @param rowId - ID of row updated
* @param data - Optional additional data to log
*/
export const auditChangeAtom = atom<AuditChangeFunction | undefined>(undefined);
/**
* Store total number of rows in the table, respecting current filters.
* If `undefined`, the query hasn’t loaded yet.
*/
export const serverDocCountAtom = atom<number | undefined>(undefined);