@vuu-ui/vuu-table-extras 3.5.3 → 3.5.4
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.
- package/package.json +12 -12
- package/src/csv-export/export-utils.js +13 -4
- package/src/csv-upload/parse/csv-upload-utils.js +44 -2
- package/src/csv-upload/session/index.js +2 -0
- package/src/csv-upload/session/useImportSchema.js +44 -0
- package/src/csv-upload/session/useImportSession.js +201 -0
- package/src/csv-upload/useCsvUpload.js +28 -186
- package/types/csv-upload/parse/csv-upload-utils.d.ts +5 -0
- package/types/csv-upload/session/index.d.ts +2 -0
- package/types/csv-upload/session/useImportSchema.d.ts +13 -0
- package/types/csv-upload/session/useImportSession.d.ts +25 -0
- package/types/csv-upload/useCsvUpload.d.ts +1 -1
package/package.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "3.5.
|
|
2
|
+
"version": "3.5.4",
|
|
3
3
|
"author": "heswell",
|
|
4
4
|
"main": "./src/index.js",
|
|
5
5
|
"license": "Apache-2.0",
|
|
@@ -11,19 +11,19 @@
|
|
|
11
11
|
"lezer-generate:column": "lezer-generator --output ./src/column-expression-input/column-language-parser/generated/column-parser.js ./src/column-expression-input/column-language-parser/grammar/column.grammar"
|
|
12
12
|
},
|
|
13
13
|
"devDependencies": {
|
|
14
|
-
"@vuu-ui/vuu-filter-types": "3.5.
|
|
15
|
-
"@vuu-ui/vuu-protocol-types": "3.5.
|
|
14
|
+
"@vuu-ui/vuu-filter-types": "3.5.4",
|
|
15
|
+
"@vuu-ui/vuu-protocol-types": "3.5.4"
|
|
16
16
|
},
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@vuu-ui/vuu-codemirror": "3.5.
|
|
19
|
-
"@vuu-ui/vuu-data-editing": "3.5.
|
|
20
|
-
"@vuu-ui/vuu-data-react": "3.5.
|
|
21
|
-
"@vuu-ui/vuu-data-types": "3.5.
|
|
22
|
-
"@vuu-ui/vuu-table-types": "3.5.
|
|
23
|
-
"@vuu-ui/vuu-popups": "3.5.
|
|
24
|
-
"@vuu-ui/vuu-table": "3.5.
|
|
25
|
-
"@vuu-ui/vuu-utils": "3.5.
|
|
26
|
-
"@vuu-ui/vuu-ui-controls": "3.5.
|
|
18
|
+
"@vuu-ui/vuu-codemirror": "3.5.4",
|
|
19
|
+
"@vuu-ui/vuu-data-editing": "3.5.4",
|
|
20
|
+
"@vuu-ui/vuu-data-react": "3.5.4",
|
|
21
|
+
"@vuu-ui/vuu-data-types": "3.5.4",
|
|
22
|
+
"@vuu-ui/vuu-table-types": "3.5.4",
|
|
23
|
+
"@vuu-ui/vuu-popups": "3.5.4",
|
|
24
|
+
"@vuu-ui/vuu-table": "3.5.4",
|
|
25
|
+
"@vuu-ui/vuu-utils": "3.5.4",
|
|
26
|
+
"@vuu-ui/vuu-ui-controls": "3.5.4",
|
|
27
27
|
"@lezer/lr": "1.4.2",
|
|
28
28
|
"@salt-ds/core": "1.54.1",
|
|
29
29
|
"@salt-ds/lab": "1.0.0-alpha.83",
|
|
@@ -51,8 +51,9 @@ const isExportableColumn = (descriptor)=>{
|
|
|
51
51
|
const exportCsvTemplate = async (dataSource, options = {})=>{
|
|
52
52
|
const { filename = "template.csv", excludeColumns = [], columns, overrides, timeout = DEFAULT_TEMPLATE_TIMEOUT, onError, onSuccess } = options;
|
|
53
53
|
const targetColumnNames = columns ? columns.filter((col)=>"string" == typeof col ? true : isExportableColumn(col) && "client" !== col.source).map((col)=>"string" == typeof col ? col : col.name) : void 0;
|
|
54
|
-
const
|
|
55
|
-
|
|
54
|
+
const targetColumns = targetColumnNames ?? overrides?.columns;
|
|
55
|
+
const sessionOverrides = overrides ?? (targetColumns ? {
|
|
56
|
+
columns: targetColumns
|
|
56
57
|
} : void 0);
|
|
57
58
|
if (!isSessionTable(dataSource.table) && dataSource.createSessionDataSource && "initialising" !== dataSource.status && "unsubscribed" !== dataSource.status) try {
|
|
58
59
|
const sessionDataSource = await dataSource.createSessionDataSource("Empty", "export", sessionOverrides);
|
|
@@ -80,7 +81,16 @@ const exportCsvTemplate = async (dataSource, options = {})=>{
|
|
|
80
81
|
}, (message)=>{
|
|
81
82
|
if ("subscribed" === message.type) {
|
|
82
83
|
const { columns: subColumns } = message;
|
|
83
|
-
const exportCols = subColumns.filter((name)=>!excluded.has(name));
|
|
84
|
+
const exportCols = targetColumns ? targetColumns.filter((name)=>!excluded.has(name)) : subColumns.filter((name)=>!excluded.has(name));
|
|
85
|
+
if (0 === exportCols.length) {
|
|
86
|
+
cleanup();
|
|
87
|
+
const error = new Error("exportCsvTemplate: no columns available for export");
|
|
88
|
+
if (onError) {
|
|
89
|
+
onError(error);
|
|
90
|
+
resolve();
|
|
91
|
+
} else reject(error);
|
|
92
|
+
return;
|
|
93
|
+
}
|
|
84
94
|
const header = exportCols.map(csvCell).join(",");
|
|
85
95
|
triggerCsvDownload(`${header}\r\n`, filename);
|
|
86
96
|
cleanup();
|
|
@@ -93,7 +103,6 @@ const exportCsvTemplate = async (dataSource, options = {})=>{
|
|
|
93
103
|
console.warn("[exportCsvTemplate] createSessionDataSource failed, falling back to tableSchema", error);
|
|
94
104
|
}
|
|
95
105
|
const schema = dataSource.tableSchema;
|
|
96
|
-
const targetColumns = targetColumnNames ?? overrides?.columns;
|
|
97
106
|
if (void 0 !== targetColumns) {
|
|
98
107
|
if (schema) {
|
|
99
108
|
const schemaColumnNames = new Set(schema.columns.map((col)=>col.name));
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { isRpcError } from "@vuu-ui/vuu-utils";
|
|
1
|
+
import { isRpcError, metadataKeys } from "@vuu-ui/vuu-utils";
|
|
2
2
|
import { CSV_FIRST_DATA_ROW_NUMBER } from "./csv-constants.js";
|
|
3
3
|
const isRecord = (value)=>"object" == typeof value && null !== value;
|
|
4
4
|
const toErrorMessage = (error)=>error instanceof Error ? error.message : String(error);
|
|
@@ -56,4 +56,46 @@ const executeBatchRpcCalls = async (items, executor, errorFormatter)=>{
|
|
|
56
56
|
results
|
|
57
57
|
};
|
|
58
58
|
};
|
|
59
|
-
|
|
59
|
+
const getInlineRowErrorMessage = (result)=>{
|
|
60
|
+
if (isRecord(result) && "data" in result && isRecord(result.data)) {
|
|
61
|
+
const data = result.data;
|
|
62
|
+
const msg = data.vuuMsg ?? data.msg;
|
|
63
|
+
if ("string" == typeof msg && "" !== msg.trim()) return msg;
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
const getRowVuuMsgError = (row, vuuMsgDataIndex, vuuRowNumDataIndex)=>{
|
|
67
|
+
if (-1 === vuuMsgDataIndex) return;
|
|
68
|
+
const msg = Array.isArray(row) ? row[vuuMsgDataIndex] : row?.vuuMsg;
|
|
69
|
+
if ("string" == typeof msg && "" !== msg.trim()) {
|
|
70
|
+
const rowNum = -1 !== vuuRowNumDataIndex && void 0 !== row[vuuRowNumDataIndex] ? row[vuuRowNumDataIndex] : Number(row[metadataKeys.IDX]) + CSV_FIRST_DATA_ROW_NUMBER;
|
|
71
|
+
return `Row ${rowNum}: ${msg}`;
|
|
72
|
+
}
|
|
73
|
+
};
|
|
74
|
+
const waitForSessionErrors = (isRemote, sessionErrors, receivedRowKeys, expectedRowCount, listeners, timeoutMs = 500)=>{
|
|
75
|
+
if (sessionErrors.size > 0 || !isRemote) return Promise.resolve([
|
|
76
|
+
...sessionErrors.values()
|
|
77
|
+
]);
|
|
78
|
+
return new Promise((resolve)=>{
|
|
79
|
+
let timeoutId;
|
|
80
|
+
const onUpdate = ()=>{
|
|
81
|
+
if (sessionErrors.size > 0 || receivedRowKeys.size >= expectedRowCount) {
|
|
82
|
+
cleanup();
|
|
83
|
+
resolve([
|
|
84
|
+
...sessionErrors.values()
|
|
85
|
+
]);
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
const cleanup = ()=>{
|
|
89
|
+
clearTimeout(timeoutId);
|
|
90
|
+
listeners.delete(onUpdate);
|
|
91
|
+
};
|
|
92
|
+
listeners.add(onUpdate);
|
|
93
|
+
timeoutId = setTimeout(()=>{
|
|
94
|
+
cleanup();
|
|
95
|
+
resolve([
|
|
96
|
+
...sessionErrors.values()
|
|
97
|
+
]);
|
|
98
|
+
}, timeoutMs);
|
|
99
|
+
});
|
|
100
|
+
};
|
|
101
|
+
export { buildRowErrorMessage, createUploadError, executeBatchRpcCalls, getInlineRowErrorMessage, getRowVuuMsgError, hasFileParseErrors, isCsvParseError, mergeValidationWithParseErrors, normalizeTableData, toErrorMessage, toValidationErrorsFromParseRowErrors, waitForSessionErrors };
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { useData } from "@vuu-ui/vuu-utils";
|
|
2
|
+
import { useEffect, useMemo, useState } from "react";
|
|
3
|
+
const useImportSchema = ({ dataSource, importSchema, importTable })=>{
|
|
4
|
+
const { getServerAPI } = useData();
|
|
5
|
+
const [fetchedImportSchema, setFetchedImportSchema] = useState();
|
|
6
|
+
useEffect(()=>{
|
|
7
|
+
if (importSchema || void 0 === importTable) return void setFetchedImportSchema(void 0);
|
|
8
|
+
let cancelled = false;
|
|
9
|
+
(async ()=>{
|
|
10
|
+
try {
|
|
11
|
+
const server = await getServerAPI();
|
|
12
|
+
const tableSchema = await server.getTableSchema(importTable);
|
|
13
|
+
if (!cancelled) setFetchedImportSchema(tableSchema);
|
|
14
|
+
} catch (error) {
|
|
15
|
+
console.error("[useImportSchema] failed to fetch import table schema", error);
|
|
16
|
+
}
|
|
17
|
+
})();
|
|
18
|
+
return ()=>{
|
|
19
|
+
cancelled = true;
|
|
20
|
+
};
|
|
21
|
+
}, [
|
|
22
|
+
getServerAPI,
|
|
23
|
+
importSchema,
|
|
24
|
+
importTable
|
|
25
|
+
]);
|
|
26
|
+
const resolvedImportSchema = importSchema ?? fetchedImportSchema;
|
|
27
|
+
const sessionOverrides = useMemo(()=>{
|
|
28
|
+
const columns = resolvedImportSchema?.columns.map(({ name })=>name);
|
|
29
|
+
return columns || importTable ? {
|
|
30
|
+
columns,
|
|
31
|
+
table: importTable
|
|
32
|
+
} : void 0;
|
|
33
|
+
}, [
|
|
34
|
+
resolvedImportSchema,
|
|
35
|
+
importTable
|
|
36
|
+
]);
|
|
37
|
+
const schema = importTable ? resolvedImportSchema : resolvedImportSchema ?? dataSource.tableSchema;
|
|
38
|
+
return {
|
|
39
|
+
resolvedImportSchema,
|
|
40
|
+
schema,
|
|
41
|
+
sessionOverrides
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
export { useImportSchema };
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import { EditSession } from "@vuu-ui/vuu-data-editing";
|
|
2
|
+
import { Range, buildColumnMap, isRpcError, isSessionTable, metadataKeys } from "@vuu-ui/vuu-utils";
|
|
3
|
+
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
4
|
+
import { buildRowErrorMessage, getInlineRowErrorMessage, getRowVuuMsgError, toErrorMessage, waitForSessionErrors } from "../parse/csv-upload-utils.js";
|
|
5
|
+
import { CSV_FIRST_DATA_ROW_NUMBER } from "../parse/csv-constants.js";
|
|
6
|
+
const useImportSession = ({ dataSource, sessionOverrides, rowDefaults, processingPromiseRef, onImportSessionEnded })=>{
|
|
7
|
+
const sessionErrorsRef = useRef(new Map());
|
|
8
|
+
const receivedRowKeysRef = useRef(new Set());
|
|
9
|
+
const sessionRowUpdateListenersRef = useRef(new Set());
|
|
10
|
+
const importDataSource = useMemo(()=>({
|
|
11
|
+
tableSchema: dataSource.tableSchema,
|
|
12
|
+
createSessionDataSource: async (copyOption, sessionType)=>{
|
|
13
|
+
if (!dataSource.createSessionDataSource) throw Error("[useCsvUpload] dataSource does not support createSessionDataSource");
|
|
14
|
+
const sessionDs = await dataSource.createSessionDataSource(copyOption, sessionType, sessionOverrides);
|
|
15
|
+
if (!sessionDs) throw Error("[useCsvUpload] Failed to create session datasource");
|
|
16
|
+
if (!sessionDs.columns.includes("vuuMsg")) sessionDs.columns = sessionDs.columns.concat("vuuMsg");
|
|
17
|
+
const columnMap = buildColumnMap(sessionDs.columns);
|
|
18
|
+
const vuuMsgDataIndex = columnMap.vuuMsg ?? -1;
|
|
19
|
+
const vuuRowNumDataIndex = columnMap.vuuRowNum ?? -1;
|
|
20
|
+
const handleSessionMessage = (message)=>{
|
|
21
|
+
if ("viewport-update" === message.type && message.rows) {
|
|
22
|
+
for (const row of message.rows){
|
|
23
|
+
const rowKey = row[metadataKeys.KEY] ?? row[metadataKeys.IDX];
|
|
24
|
+
receivedRowKeysRef.current.add(rowKey);
|
|
25
|
+
const error = getRowVuuMsgError(row, vuuMsgDataIndex, vuuRowNumDataIndex);
|
|
26
|
+
if (error) sessionErrorsRef.current.set(rowKey, error);
|
|
27
|
+
}
|
|
28
|
+
for (const listener of sessionRowUpdateListenersRef.current)listener();
|
|
29
|
+
} else if ("viewport-clear" === message.type) {
|
|
30
|
+
sessionErrorsRef.current.clear();
|
|
31
|
+
receivedRowKeysRef.current.clear();
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
if (sessionDs.isRemote) return new Promise((resolve, reject)=>{
|
|
35
|
+
const handleSubscribed = ()=>{
|
|
36
|
+
sessionDs.removeListener("subscribed", handleSubscribed);
|
|
37
|
+
resolve(sessionDs);
|
|
38
|
+
};
|
|
39
|
+
sessionDs.on("subscribed", handleSubscribed);
|
|
40
|
+
try {
|
|
41
|
+
sessionDs.subscribe({
|
|
42
|
+
range: Range(0, 0)
|
|
43
|
+
}, handleSessionMessage);
|
|
44
|
+
} catch (err) {
|
|
45
|
+
sessionDs.removeListener("subscribed", handleSubscribed);
|
|
46
|
+
reject(err);
|
|
47
|
+
}
|
|
48
|
+
});
|
|
49
|
+
if ("function" == typeof sessionDs.subscribe && "initialising" === sessionDs.status) try {
|
|
50
|
+
sessionDs.subscribe({
|
|
51
|
+
range: Range(0, 0)
|
|
52
|
+
}, handleSessionMessage);
|
|
53
|
+
} catch {}
|
|
54
|
+
return sessionDs;
|
|
55
|
+
}
|
|
56
|
+
}), [
|
|
57
|
+
dataSource,
|
|
58
|
+
sessionOverrides
|
|
59
|
+
]);
|
|
60
|
+
const editSession = useMemo(()=>new EditSession({
|
|
61
|
+
dataSource: importDataSource,
|
|
62
|
+
editSessionApi: "createSessionDataSource",
|
|
63
|
+
rowDefaults
|
|
64
|
+
}), [
|
|
65
|
+
importDataSource,
|
|
66
|
+
rowDefaults
|
|
67
|
+
]);
|
|
68
|
+
const ownsEditSessionRef = useRef(true);
|
|
69
|
+
const sessionDataSourceRef = useRef(void 0);
|
|
70
|
+
const [sessionTable, setSessionTable] = useState();
|
|
71
|
+
useEffect(()=>()=>{
|
|
72
|
+
const processingPromise = processingPromiseRef?.current;
|
|
73
|
+
(async ()=>{
|
|
74
|
+
try {
|
|
75
|
+
await processingPromise;
|
|
76
|
+
} finally{
|
|
77
|
+
if (ownsEditSessionRef.current) try {
|
|
78
|
+
const sessionDs = sessionDataSourceRef.current ?? editSession.sessionDataSource;
|
|
79
|
+
if (sessionDs?.status !== "unsubscribed") await editSession.end(false);
|
|
80
|
+
} catch (error) {
|
|
81
|
+
console.error("[useCsvUpload] failed to discard edit session during cleanup", error);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
})();
|
|
85
|
+
}, [
|
|
86
|
+
editSession,
|
|
87
|
+
processingPromiseRef
|
|
88
|
+
]);
|
|
89
|
+
const setActiveSessionDataSource = useCallback((sessionDataSource)=>{
|
|
90
|
+
sessionDataSourceRef.current = sessionDataSource;
|
|
91
|
+
const table = sessionDataSource?.table;
|
|
92
|
+
setSessionTable(table && isSessionTable(table) ? table : void 0);
|
|
93
|
+
}, []);
|
|
94
|
+
const endEditSessionAndNotify = useCallback(async (save, reason)=>{
|
|
95
|
+
ownsEditSessionRef.current = false;
|
|
96
|
+
const sessionDataSource = sessionDataSourceRef.current;
|
|
97
|
+
if (!sessionDataSource) throw Error("CsvUpload has no active edit session.");
|
|
98
|
+
if (!sessionDataSource.endEditSession) throw Error("CsvUpload requires the session datasource to support endEditSession.");
|
|
99
|
+
const currentSessionTable = sessionDataSource.table;
|
|
100
|
+
try {
|
|
101
|
+
await editSession.end(save);
|
|
102
|
+
} finally{
|
|
103
|
+
if ("unsubscribed" !== sessionDataSource.status && "function" == typeof sessionDataSource.unsubscribe) sessionDataSource.unsubscribe();
|
|
104
|
+
setActiveSessionDataSource(void 0);
|
|
105
|
+
}
|
|
106
|
+
onImportSessionEnded?.({
|
|
107
|
+
reason,
|
|
108
|
+
sessionTable: currentSessionTable && isSessionTable(currentSessionTable) ? currentSessionTable : void 0
|
|
109
|
+
});
|
|
110
|
+
}, [
|
|
111
|
+
editSession,
|
|
112
|
+
onImportSessionEnded,
|
|
113
|
+
setActiveSessionDataSource
|
|
114
|
+
]);
|
|
115
|
+
const beginEditSession = useCallback(async ()=>{
|
|
116
|
+
sessionErrorsRef.current.clear();
|
|
117
|
+
receivedRowKeysRef.current.clear();
|
|
118
|
+
ownsEditSessionRef.current = true;
|
|
119
|
+
const sessionDataSource = await editSession.begin("Empty", "import");
|
|
120
|
+
const sessionVuuTable = sessionDataSource?.table;
|
|
121
|
+
if (void 0 === sessionDataSource || void 0 === sessionVuuTable || !isSessionTable(sessionVuuTable)) throw Error("CsvUpload createSessionDataSource returned no session datasource.");
|
|
122
|
+
setActiveSessionDataSource(sessionDataSource);
|
|
123
|
+
return sessionDataSource;
|
|
124
|
+
}, [
|
|
125
|
+
editSession,
|
|
126
|
+
setActiveSessionDataSource
|
|
127
|
+
]);
|
|
128
|
+
const closePendingEditSession = useCallback(async (save)=>{
|
|
129
|
+
if (void 0 === sessionDataSourceRef.current) return;
|
|
130
|
+
await endEditSessionAndNotify(save, save ? "saved" : "discarded");
|
|
131
|
+
}, [
|
|
132
|
+
endEditSessionAndNotify
|
|
133
|
+
]);
|
|
134
|
+
const releaseEditSessionOwnership = useCallback(()=>{
|
|
135
|
+
ownsEditSessionRef.current = false;
|
|
136
|
+
}, []);
|
|
137
|
+
const addAllRows = useCallback(async (mergedValidation, isCancelled)=>{
|
|
138
|
+
const vuuMsgByRow = new Map();
|
|
139
|
+
for (const { rowNum, column, message } of mergedValidation.errors){
|
|
140
|
+
if (rowNum < CSV_FIRST_DATA_ROW_NUMBER) continue;
|
|
141
|
+
const existing = vuuMsgByRow.get(rowNum);
|
|
142
|
+
const columnError = `${column}: ${message}`;
|
|
143
|
+
vuuMsgByRow.set(rowNum, existing ? `${existing}; ${columnError}` : columnError);
|
|
144
|
+
}
|
|
145
|
+
const parsedRowCount = mergedValidation.rows.length;
|
|
146
|
+
const unparsedErrorRows = [
|
|
147
|
+
...vuuMsgByRow.keys()
|
|
148
|
+
].filter((rowNum)=>rowNum - CSV_FIRST_DATA_ROW_NUMBER >= parsedRowCount).map((rowNum)=>({
|
|
149
|
+
rowNum,
|
|
150
|
+
rowData: {},
|
|
151
|
+
vuuMsg: vuuMsgByRow.get(rowNum) ?? ""
|
|
152
|
+
}));
|
|
153
|
+
const allRows = [
|
|
154
|
+
...mergedValidation.rows.map((rowData, idx)=>({
|
|
155
|
+
rowNum: idx + CSV_FIRST_DATA_ROW_NUMBER,
|
|
156
|
+
rowData: rowData ?? {},
|
|
157
|
+
vuuMsg: vuuMsgByRow.get(idx + CSV_FIRST_DATA_ROW_NUMBER) ?? ""
|
|
158
|
+
})),
|
|
159
|
+
...unparsedErrorRows
|
|
160
|
+
];
|
|
161
|
+
const rpcErrors = [];
|
|
162
|
+
for (const { rowNum, rowData, vuuMsg } of allRows){
|
|
163
|
+
if (isCancelled()) return false;
|
|
164
|
+
try {
|
|
165
|
+
const payload = vuuMsg ? {
|
|
166
|
+
vuuRowNum: rowNum,
|
|
167
|
+
vuuMsg
|
|
168
|
+
} : {
|
|
169
|
+
...rowData,
|
|
170
|
+
vuuRowNum: rowNum,
|
|
171
|
+
vuuMsg
|
|
172
|
+
};
|
|
173
|
+
const result = await editSession.addRow(payload);
|
|
174
|
+
if (isRpcError(result)) throw Error(result.errorMessage);
|
|
175
|
+
if ("string" == typeof result) throw Error(result);
|
|
176
|
+
const inlineMsg = getInlineRowErrorMessage(result);
|
|
177
|
+
if (inlineMsg) rpcErrors.push(`${0 === rowNum ? "Header" : `Row ${rowNum}`}: ${inlineMsg}`);
|
|
178
|
+
} catch (error) {
|
|
179
|
+
rpcErrors.push(`${0 === rowNum ? "Header" : `Row ${rowNum}`}: ${toErrorMessage(error)}`);
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
if (rpcErrors.length > 0) throw Error(buildRowErrorMessage("Import failed", rpcErrors));
|
|
183
|
+
return allRows.length;
|
|
184
|
+
}, [
|
|
185
|
+
editSession
|
|
186
|
+
]);
|
|
187
|
+
const checkSessionTableErrors = useCallback(async (sessionDs, expectedRowCount)=>waitForSessionErrors(sessionDs.isRemote ?? false, sessionErrorsRef.current, receivedRowKeysRef.current, expectedRowCount, sessionRowUpdateListenersRef.current), []);
|
|
188
|
+
return {
|
|
189
|
+
addAllRows,
|
|
190
|
+
beginEditSession,
|
|
191
|
+
checkSessionTableErrors,
|
|
192
|
+
closePendingEditSession,
|
|
193
|
+
editSession,
|
|
194
|
+
endEditSessionAndNotify,
|
|
195
|
+
releaseEditSessionOwnership,
|
|
196
|
+
sessionDataSourceRef,
|
|
197
|
+
sessionTable,
|
|
198
|
+
setActiveSessionDataSource
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
export { useImportSession };
|
|
@@ -1,203 +1,36 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
1
|
+
import { Range, isSessionTable } from "@vuu-ui/vuu-utils";
|
|
2
|
+
import { useCallback, useMemo, useRef, useState } from "react";
|
|
4
3
|
import { parseCsv } from "./parse/csv-parse.js";
|
|
5
4
|
import { validateCsvAgainstSchema } from "./parse/csv-schema-validation.js";
|
|
6
5
|
import { buildRowErrorMessage, createUploadError, hasFileParseErrors, isCsvParseError, mergeValidationWithParseErrors, toErrorMessage } from "./parse/csv-upload-utils.js";
|
|
7
|
-
import {
|
|
6
|
+
import { useImportSchema } from "./session/useImportSchema.js";
|
|
7
|
+
import { useImportSession } from "./session/useImportSession.js";
|
|
8
8
|
const useCsvUpload = ({ dataSource, importMode = "direct", importSchema, importTable, onImportSessionEnded, onImportSessionReady, onError, onImported, onPreview, onProcessingStarted, maxRows, parseOptions, rowDefaults, validators })=>{
|
|
9
|
-
const { getServerAPI } = useData();
|
|
10
9
|
const [validation, setValidation] = useState();
|
|
11
|
-
const [sessionTable, setSessionTable] = useState();
|
|
12
10
|
const [isProcessingFile, setIsProcessingFile] = useState(false);
|
|
13
11
|
const [isImporting, setIsImporting] = useState(false);
|
|
14
|
-
const [fetchedImportSchema, setFetchedImportSchema] = useState();
|
|
15
12
|
const [error, setError] = useState();
|
|
13
|
+
const operationIdRef = useRef(0);
|
|
14
|
+
const processingPromiseRef = useRef(void 0);
|
|
16
15
|
const handleError = useCallback((errResult)=>{
|
|
17
16
|
setError(errResult);
|
|
18
17
|
onError?.(errResult);
|
|
19
18
|
}, [
|
|
20
19
|
onError
|
|
21
20
|
]);
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
let cancelled = false;
|
|
25
|
-
(async ()=>{
|
|
26
|
-
try {
|
|
27
|
-
const server = await getServerAPI();
|
|
28
|
-
const tableSchema = await server.getTableSchema(importTable);
|
|
29
|
-
if (!cancelled) setFetchedImportSchema(tableSchema);
|
|
30
|
-
} catch (error) {
|
|
31
|
-
console.error("[useCsvUpload] failed to fetch import table schema", error);
|
|
32
|
-
}
|
|
33
|
-
})();
|
|
34
|
-
return ()=>{
|
|
35
|
-
cancelled = true;
|
|
36
|
-
};
|
|
37
|
-
}, [
|
|
38
|
-
getServerAPI,
|
|
21
|
+
const { schema, sessionOverrides } = useImportSchema({
|
|
22
|
+
dataSource,
|
|
39
23
|
importSchema,
|
|
40
24
|
importTable
|
|
41
|
-
|
|
42
|
-
const
|
|
43
|
-
const sessionOverrides = useMemo(()=>{
|
|
44
|
-
const columns = resolvedImportSchema?.columns.map(({ name })=>name);
|
|
45
|
-
return columns || importTable ? {
|
|
46
|
-
columns,
|
|
47
|
-
table: importTable
|
|
48
|
-
} : void 0;
|
|
49
|
-
}, [
|
|
50
|
-
resolvedImportSchema,
|
|
51
|
-
importTable
|
|
52
|
-
]);
|
|
53
|
-
const importDataSource = useMemo(()=>({
|
|
54
|
-
tableSchema: dataSource.tableSchema,
|
|
55
|
-
createSessionDataSource: async (copyOption, sessionType)=>{
|
|
56
|
-
if (!dataSource.createSessionDataSource) throw Error("[useCsvUpload] dataSource does not support createSessionDataSource");
|
|
57
|
-
const sessionDs = await dataSource.createSessionDataSource(copyOption, sessionType, sessionOverrides);
|
|
58
|
-
if (!sessionDs) throw Error("[useCsvUpload] Failed to create session datasource");
|
|
59
|
-
if (!sessionDs.columns.includes("vuuMsg")) sessionDs.columns = sessionDs.columns.concat("vuuMsg");
|
|
60
|
-
if (sessionDs.isRemote) return new Promise((resolve, reject)=>{
|
|
61
|
-
const handleSubscribed = ()=>{
|
|
62
|
-
sessionDs.removeListener("subscribed", handleSubscribed);
|
|
63
|
-
resolve(sessionDs);
|
|
64
|
-
};
|
|
65
|
-
sessionDs.on("subscribed", handleSubscribed);
|
|
66
|
-
try {
|
|
67
|
-
sessionDs.subscribe({
|
|
68
|
-
range: Range(0, 0)
|
|
69
|
-
}, ()=>{});
|
|
70
|
-
} catch (err) {
|
|
71
|
-
sessionDs.removeListener("subscribed", handleSubscribed);
|
|
72
|
-
reject(err);
|
|
73
|
-
}
|
|
74
|
-
});
|
|
75
|
-
return sessionDs;
|
|
76
|
-
}
|
|
77
|
-
}), [
|
|
25
|
+
});
|
|
26
|
+
const { addAllRows, beginEditSession, checkSessionTableErrors, closePendingEditSession, editSession, endEditSessionAndNotify, releaseEditSessionOwnership, sessionDataSourceRef, sessionTable, setActiveSessionDataSource } = useImportSession({
|
|
78
27
|
dataSource,
|
|
79
|
-
sessionOverrides
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
rowDefaults
|
|
85
|
-
}), [
|
|
86
|
-
importDataSource,
|
|
87
|
-
rowDefaults
|
|
88
|
-
]);
|
|
89
|
-
const ownsEditSessionRef = useRef(true);
|
|
90
|
-
const operationIdRef = useRef(0);
|
|
91
|
-
const processingPromiseRef = useRef(void 0);
|
|
92
|
-
const sessionDataSourceRef = useRef(void 0);
|
|
93
|
-
useEffect(()=>()=>{
|
|
94
|
-
operationIdRef.current++;
|
|
95
|
-
const processingPromise = processingPromiseRef.current;
|
|
96
|
-
(async ()=>{
|
|
97
|
-
try {
|
|
98
|
-
await processingPromise;
|
|
99
|
-
} finally{
|
|
100
|
-
if (ownsEditSessionRef.current) try {
|
|
101
|
-
await editSession.end(false);
|
|
102
|
-
} catch (error) {
|
|
103
|
-
console.error("[useCsvUpload] failed to discard edit session during cleanup", error);
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
})();
|
|
107
|
-
}, [
|
|
108
|
-
editSession
|
|
109
|
-
]);
|
|
110
|
-
const setActiveSessionDataSource = useCallback((sessionDataSource)=>{
|
|
111
|
-
sessionDataSourceRef.current = sessionDataSource;
|
|
112
|
-
const table = sessionDataSource?.table;
|
|
113
|
-
setSessionTable(table && isSessionTable(table) ? table : void 0);
|
|
114
|
-
}, []);
|
|
115
|
-
const endEditSessionAndNotify = useCallback(async (save, reason)=>{
|
|
116
|
-
const sessionDataSource = sessionDataSourceRef.current;
|
|
117
|
-
if (!sessionDataSource) throw Error("CsvUpload has no active edit session.");
|
|
118
|
-
if (!sessionDataSource.endEditSession) throw Error("CsvUpload requires the session datasource to support endEditSession.");
|
|
119
|
-
const currentSessionTable = sessionDataSource.table;
|
|
120
|
-
try {
|
|
121
|
-
await editSession.end(save);
|
|
122
|
-
} finally{
|
|
123
|
-
if ("unsubscribed" !== sessionDataSource.status && "function" == typeof sessionDataSource.unsubscribe) sessionDataSource.unsubscribe();
|
|
124
|
-
setActiveSessionDataSource(void 0);
|
|
125
|
-
}
|
|
126
|
-
onImportSessionEnded?.({
|
|
127
|
-
reason,
|
|
128
|
-
sessionTable: currentSessionTable && isSessionTable(currentSessionTable) ? currentSessionTable : void 0
|
|
129
|
-
});
|
|
130
|
-
}, [
|
|
131
|
-
editSession,
|
|
132
|
-
onImportSessionEnded,
|
|
133
|
-
setActiveSessionDataSource
|
|
134
|
-
]);
|
|
28
|
+
sessionOverrides,
|
|
29
|
+
rowDefaults,
|
|
30
|
+
processingPromiseRef,
|
|
31
|
+
onImportSessionEnded
|
|
32
|
+
});
|
|
135
33
|
const table = dataSource.table;
|
|
136
|
-
const schema = importTable ? resolvedImportSchema : resolvedImportSchema ?? dataSource.tableSchema;
|
|
137
|
-
const addAllRows = useCallback(async (mergedValidation, operationId)=>{
|
|
138
|
-
const vuuMsgByRow = new Map();
|
|
139
|
-
for (const { rowNum, column, message } of mergedValidation.errors){
|
|
140
|
-
if (rowNum < CSV_FIRST_DATA_ROW_NUMBER) continue;
|
|
141
|
-
const existing = vuuMsgByRow.get(rowNum);
|
|
142
|
-
const columnError = `${column}: ${message}`;
|
|
143
|
-
vuuMsgByRow.set(rowNum, existing ? `${existing}; ${columnError}` : columnError);
|
|
144
|
-
}
|
|
145
|
-
const parsedRowCount = mergedValidation.rows.length;
|
|
146
|
-
const unparsedErrorRows = [
|
|
147
|
-
...vuuMsgByRow.keys()
|
|
148
|
-
].filter((rowNum)=>rowNum - CSV_FIRST_DATA_ROW_NUMBER >= parsedRowCount).map((rowNum)=>({
|
|
149
|
-
rowNum,
|
|
150
|
-
rowData: {},
|
|
151
|
-
vuuMsg: vuuMsgByRow.get(rowNum) ?? ""
|
|
152
|
-
}));
|
|
153
|
-
const allRows = [
|
|
154
|
-
...mergedValidation.rows.map((rowData, idx)=>({
|
|
155
|
-
rowNum: idx + CSV_FIRST_DATA_ROW_NUMBER,
|
|
156
|
-
rowData: rowData ?? {},
|
|
157
|
-
vuuMsg: vuuMsgByRow.get(idx + CSV_FIRST_DATA_ROW_NUMBER) ?? ""
|
|
158
|
-
})),
|
|
159
|
-
...unparsedErrorRows
|
|
160
|
-
];
|
|
161
|
-
const rpcErrors = [];
|
|
162
|
-
for (const { rowNum, rowData, vuuMsg } of allRows){
|
|
163
|
-
if (operationId !== operationIdRef.current) return false;
|
|
164
|
-
try {
|
|
165
|
-
const payload = vuuMsg ? {
|
|
166
|
-
vuuRowNum: rowNum,
|
|
167
|
-
vuuMsg
|
|
168
|
-
} : {
|
|
169
|
-
...rowData,
|
|
170
|
-
vuuRowNum: rowNum,
|
|
171
|
-
vuuMsg
|
|
172
|
-
};
|
|
173
|
-
const result = await editSession.addRow(payload);
|
|
174
|
-
if (isRpcError(result)) throw Error(result.errorMessage);
|
|
175
|
-
if ("string" == typeof result) throw Error(result);
|
|
176
|
-
} catch (error) {
|
|
177
|
-
rpcErrors.push(`${0 === rowNum ? "Header" : `Row ${rowNum}`}: ${toErrorMessage(error)}`);
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
if (rpcErrors.length > 0) throw Error(buildRowErrorMessage("Import failed", rpcErrors));
|
|
181
|
-
return true;
|
|
182
|
-
}, [
|
|
183
|
-
editSession
|
|
184
|
-
]);
|
|
185
|
-
const beginEditSession = useCallback(async ()=>{
|
|
186
|
-
const sessionDataSource = await editSession.begin("Empty", "import");
|
|
187
|
-
const sessionVuuTable = sessionDataSource?.table;
|
|
188
|
-
if (void 0 === sessionDataSource || void 0 === sessionVuuTable || !isSessionTable(sessionVuuTable)) throw Error("CsvUpload createSessionDataSource returned no session datasource.");
|
|
189
|
-
setActiveSessionDataSource(sessionDataSource);
|
|
190
|
-
return sessionDataSource;
|
|
191
|
-
}, [
|
|
192
|
-
editSession,
|
|
193
|
-
setActiveSessionDataSource
|
|
194
|
-
]);
|
|
195
|
-
const closePendingEditSession = useCallback(async (save)=>{
|
|
196
|
-
if (void 0 === sessionDataSourceRef.current) return;
|
|
197
|
-
await endEditSessionAndNotify(save, save ? "saved" : "discarded");
|
|
198
|
-
}, [
|
|
199
|
-
endEditSessionAndNotify
|
|
200
|
-
]);
|
|
201
34
|
const cancelImport = useCallback(async ()=>{
|
|
202
35
|
operationIdRef.current++;
|
|
203
36
|
processingPromiseRef.current = void 0;
|
|
@@ -256,8 +89,13 @@ const useCsvUpload = ({ dataSource, importMode = "direct", importSchema, importT
|
|
|
256
89
|
if (mergedValidation.rows.length > 0) try {
|
|
257
90
|
const sessionDataSource = await beginEditSession();
|
|
258
91
|
if (operationId !== operationIdRef.current) return;
|
|
259
|
-
const
|
|
260
|
-
if (
|
|
92
|
+
const rowsAddedCount = await addAllRows(mergedValidation, ()=>operationId !== operationIdRef.current);
|
|
93
|
+
if (false === rowsAddedCount) return;
|
|
94
|
+
const expectedRowCount = rowsAddedCount;
|
|
95
|
+
sessionDataSource.range = Range(0, expectedRowCount);
|
|
96
|
+
const sessionErrors = await checkSessionTableErrors(sessionDataSource, expectedRowCount);
|
|
97
|
+
if (operationId !== operationIdRef.current) return;
|
|
98
|
+
if (sessionErrors.length > 0) throw Error(buildRowErrorMessage("Import failed", sessionErrors));
|
|
261
99
|
onImportSessionReady?.(sessionDataSource);
|
|
262
100
|
} catch (error) {
|
|
263
101
|
if (void 0 !== sessionDataSourceRef.current) await endEditSessionAndNotify(false, "failed");
|
|
@@ -277,6 +115,7 @@ const useCsvUpload = ({ dataSource, importMode = "direct", importSchema, importT
|
|
|
277
115
|
handleError,
|
|
278
116
|
editSession,
|
|
279
117
|
addAllRows,
|
|
118
|
+
checkSessionTableErrors,
|
|
280
119
|
maxRows,
|
|
281
120
|
parseOptions,
|
|
282
121
|
beginEditSession,
|
|
@@ -287,7 +126,8 @@ const useCsvUpload = ({ dataSource, importMode = "direct", importSchema, importT
|
|
|
287
126
|
endEditSessionAndNotify,
|
|
288
127
|
schema,
|
|
289
128
|
validators,
|
|
290
|
-
onImportSessionReady
|
|
129
|
+
onImportSessionReady,
|
|
130
|
+
sessionDataSourceRef
|
|
291
131
|
]);
|
|
292
132
|
const handleFiles = useCallback(async (files)=>{
|
|
293
133
|
const file = files[0];
|
|
@@ -355,7 +195,7 @@ const useCsvUpload = ({ dataSource, importMode = "direct", importSchema, importT
|
|
|
355
195
|
editSession,
|
|
356
196
|
tableData
|
|
357
197
|
});
|
|
358
|
-
|
|
198
|
+
releaseEditSessionOwnership();
|
|
359
199
|
} else {
|
|
360
200
|
await endEditSessionAndNotify(true, "saved");
|
|
361
201
|
onImported?.({
|
|
@@ -383,6 +223,8 @@ const useCsvUpload = ({ dataSource, importMode = "direct", importSchema, importT
|
|
|
383
223
|
onImported,
|
|
384
224
|
onPreview,
|
|
385
225
|
importMode,
|
|
226
|
+
releaseEditSessionOwnership,
|
|
227
|
+
sessionDataSourceRef,
|
|
386
228
|
validation
|
|
387
229
|
]);
|
|
388
230
|
return {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
|
|
2
|
+
import type { DataSourceRow } from "@vuu-ui/vuu-data-types";
|
|
2
3
|
import type { CsvUploadError } from "../CsvUpload";
|
|
3
4
|
import type { CsvParseError } from "./csv-parse";
|
|
4
5
|
import type { CsvValidationError, CsvValidationResult } from "./csv-schema-validation";
|
|
@@ -19,3 +20,7 @@ export type RpcBatchResult = {
|
|
|
19
20
|
results: unknown[];
|
|
20
21
|
};
|
|
21
22
|
export declare const executeBatchRpcCalls: <T>(items: T[], executor: (item: T) => Promise<unknown>, errorFormatter: (item: T, error: string) => string) => Promise<RpcBatchResult>;
|
|
23
|
+
export type SessionRowUpdateListener = () => void;
|
|
24
|
+
export declare const getInlineRowErrorMessage: (result: unknown) => string | undefined;
|
|
25
|
+
export declare const getRowVuuMsgError: (row: DataSourceRow, vuuMsgDataIndex: number, vuuRowNumDataIndex: number) => string | undefined;
|
|
26
|
+
export declare const waitForSessionErrors: (isRemote: boolean, sessionErrors: Map<string | number, string>, receivedRowKeys: Set<string | number>, expectedRowCount: number, listeners: Set<SessionRowUpdateListener>, timeoutMs?: number) => Promise<string[]>;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { DataSource, SessionDataSourceOverrides, TableSchema } from "@vuu-ui/vuu-data-types";
|
|
2
|
+
import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
|
|
3
|
+
export interface UseImportSchemaProps {
|
|
4
|
+
dataSource: DataSource;
|
|
5
|
+
importSchema?: TableSchema;
|
|
6
|
+
importTable?: VuuTable;
|
|
7
|
+
}
|
|
8
|
+
export interface UseImportSchemaResult {
|
|
9
|
+
resolvedImportSchema: TableSchema | undefined;
|
|
10
|
+
schema: TableSchema | undefined;
|
|
11
|
+
sessionOverrides: SessionDataSourceOverrides | undefined;
|
|
12
|
+
}
|
|
13
|
+
export declare const useImportSchema: ({ dataSource, importSchema, importTable, }: UseImportSchemaProps) => UseImportSchemaResult;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { DataSource, SessionDataSourceOverrides } from "@vuu-ui/vuu-data-types";
|
|
2
|
+
import { EditSession, type RowDefaultDataItemValues } from "@vuu-ui/vuu-data-editing";
|
|
3
|
+
import { type RefObject } from "react";
|
|
4
|
+
import type { CsvValidationResult } from "../parse/csv-schema-validation";
|
|
5
|
+
import type { CsvUploadSessionEndReason, CsvUploadSessionEndResult, CsvUploadSessionTable } from "../CsvUpload";
|
|
6
|
+
export interface UseImportSessionProps {
|
|
7
|
+
dataSource: DataSource;
|
|
8
|
+
sessionOverrides?: SessionDataSourceOverrides;
|
|
9
|
+
rowDefaults?: RowDefaultDataItemValues;
|
|
10
|
+
processingPromiseRef?: RefObject<Promise<void> | undefined>;
|
|
11
|
+
onImportSessionEnded?: (result: CsvUploadSessionEndResult) => void;
|
|
12
|
+
}
|
|
13
|
+
export interface UseImportSessionReturn {
|
|
14
|
+
addAllRows: (mergedValidation: CsvValidationResult, isCancelled: () => boolean) => Promise<number | false>;
|
|
15
|
+
beginEditSession: () => Promise<DataSource>;
|
|
16
|
+
checkSessionTableErrors: (sessionDs: DataSource, expectedRowCount: number) => Promise<string[]>;
|
|
17
|
+
closePendingEditSession: (save: boolean) => Promise<void>;
|
|
18
|
+
editSession: EditSession;
|
|
19
|
+
endEditSessionAndNotify: (save: boolean, reason: CsvUploadSessionEndReason) => Promise<void>;
|
|
20
|
+
releaseEditSessionOwnership: () => void;
|
|
21
|
+
sessionDataSourceRef: React.MutableRefObject<DataSource | undefined>;
|
|
22
|
+
sessionTable: CsvUploadSessionTable | undefined;
|
|
23
|
+
setActiveSessionDataSource: (sessionDataSource?: DataSource) => void;
|
|
24
|
+
}
|
|
25
|
+
export declare const useImportSession: ({ dataSource, sessionOverrides, rowDefaults, processingPromiseRef, onImportSessionEnded, }: UseImportSessionProps) => UseImportSessionReturn;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DataSource, TableSchema } from "@vuu-ui/vuu-data-types";
|
|
2
|
-
import {
|
|
2
|
+
import type { RowDefaultDataItemValues } from "@vuu-ui/vuu-data-editing";
|
|
3
3
|
import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
|
|
4
4
|
import { type CsvParseOptions } from "./parse/csv-parse";
|
|
5
5
|
import { type CsvValidationResult, type CsvColumnValidator } from "./parse/csv-schema-validation";
|