@adminforth/import-export 1.6.2 → 1.8.0

package/dist/index.js

@@ -13,6 +13,7 @@ import { z } from "zod";
 const exportCsvBodySchema = z.object({
     filters: z.any(),
     sort: z.any(),
+    selectedIds: z.array(z.any()).optional(),
 }).strict();
 const importCsvBodySchema = z.object({
     data: z.record(z.string(), z.array(z.unknown())),
@@ -92,10 +93,7 @@ export default class ImportExport extends AdminForthPlugin {
             }
             resourceConfig.options.pageInjections.list.threeDotsDropdownItems.push({
                 file: this.componentPath('ExportCsv.vue'),
-                meta: { pluginInstanceId: this.pluginInstanceId, select: 'all' }
-            }, {
-                file: this.componentPath('ExportCsv.vue'),
-                meta: { pluginInstanceId: this.pluginInstanceId, select: 'filtered' }
+                meta: { pluginInstanceId: this.pluginInstanceId }
             }, {
                 file: this.componentPath('ImportCsv.vue'),
                 meta: { pluginInstanceId: this.pluginInstanceId }
@@ -122,9 +120,8 @@ export default class ImportExport extends AdminForthPlugin {
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/export-csv`,
             request_schema: exportCsvBodySchema,
-            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, headers, response }) {
-                const payload = body;
-                const { filters, sort } = payload;
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, headers }) {
+                const { filters, sort, selectedIds } = body;
                 if (!filters || !sort) {
                     return { ok: false, error: 'Missing filters or sort in request body' };
                 }
@@ -139,39 +136,19 @@ export default class ImportExport extends AdminForthPlugin {
                 if (rawFilterError) {
                     return rawFilterError;
                 }
-                const data = yield this.adminforth.connectors[this.resourceConfig.dataSource].getData({
-                    resource: this.resourceConfig,
-                    limit: 1e6,
-                    offset: 0,
-                    filters: this.adminforth.connectors[this.resourceConfig.dataSource].validateAndNormalizeInputFilters(filters),
-                    sort,
-                    getTotals: true,
-                });
-                // prepare data for PapaParse unparse
-                const columns = this.resourceConfig.columns.filter((col) => !col.virtual && !col.backendOnly);
-                const columnsToForceQuote = columns.map(col => {
-                    return col.type !== AdminForthDataTypes.FLOAT
-                        && col.type !== AdminForthDataTypes.INTEGER
-                        && col.type !== AdminForthDataTypes.BOOLEAN;
-                });
-                const fields = columns.map((col) => col.name);
-                const rows = data.data.map((row) => {
-                    return columns.map((col) => {
-                        var _a;
-                        const value = row[col.name];
-                        if (col.type === AdminForthDataTypes.JSON || ((_a = col.isArray) === null || _a === void 0 ? void 0 : _a.enabled)) {
-                            return value == null ? value : JSON.stringify(value);
-                        }
-                        return value;
-                    });
-                });
-                this.tryToAuditLogAction('export', `Export CSV with filters: ${JSON.stringify(filters)} and sort: ${JSON.stringify(sort)}. Total records: ${rows.length}`, adminUser, headers);
-                return {
-                    data: { fields, data: rows },
-                    columnsToForceQuote,
-                    exportedCount: data.total,
-                    ok: true
-                };
+                let effectiveFilters = filters;
+                if (Array.isArray(selectedIds) && selectedIds.length > 0) {
+                    const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+                    if (!primaryKeyColumn) {
+                        return { ok: false, error: 'Cannot export selected records: resource has no primary key' };
+                    }
+                    effectiveFilters = [{
+                            field: primaryKeyColumn.name,
+                            operator: AdminForthFilterOperators.IN,
+                            value: selectedIds,
+                        }];
+                }
+                return this.exportCsv(effectiveFilters, sort, { adminUser, headers });
             })
         });
         server.endpoint({
@@ -179,8 +156,7 @@ export default class ImportExport extends AdminForthPlugin {
             path: `/plugin/${this.pluginInstanceId}/import-csv`,
             request_schema: importCsvBodySchema,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, query, headers, cookies, requestUrl, response }) {
-                const payload = body;
-                const { data } = payload;
+                const { data } = body;
                 if (!data || typeof data !== 'object') {
                     return { ok: false, error: 'Invalid data format. Expected an object with column names as keys and arrays of values as values.' };
                 }
@@ -191,61 +167,12 @@ export default class ImportExport extends AdminForthPlugin {
                 if (!createEditAccess.ok) {
                     return { ok: false, error: createEditAccess.error };
                 }
-                const columns = this.getColumnNames(data);
-                const { errors, resourceColumns } = this.validateColumns(columns);
-                const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
-                if (errors.length > 0) {
-                    return { ok: false, errors };
-                }
-                const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
-                const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
-                console.log('Prepared rows for import:', rows);
-                this.tryToAuditLogAction('import', `Import CSV with ${Object.keys(data).length} columns`, adminUser, headers);
-                let importedCount = 0;
-                let updatedCount = 0;
-                const limit = pLimit(100);
-                yield Promise.all(rows.map((row) => limit(() => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const rowErrors = yield this.isRowValid(row);
-                        if (rowErrors.length > 0) {
-                            errors.push(...rowErrors);
-                            return;
-                        }
-                        const recordId = primaryKeyColumn ? row[primaryKeyColumn.name] : undefined;
-                        if (primaryKeyColumn && recordId) {
-                            const existingRecord = yield this.adminforth.resource(this.resourceConfig.resourceId)
-                                .list([Filters.EQ(primaryKeyColumn.name, recordId)]);
-                            if (existingRecord.length > 0) {
-                                const connector = this.adminforth.connectors[resource.dataSource];
-                                const oldRecord = yield connector.getRecordByPrimaryKey(resource, recordId);
-                                if (!oldRecord) {
-                                    const primaryKeyColumn = resource.columns.find((col) => col.primaryKey);
-                                    return { error: `Record with ${primaryKeyColumn.name} ${recordId} not found` };
-                                }
-                                const { error } = yield this.adminforth.updateResourceRecord({
-                                    resource, updates: row, adminUser, oldRecord, recordId, response,
-                                    extra: { body, query, headers, cookies, requestUrl, response }
-                                });
-                                if (error) {
-                                    return { error };
-                                }
-                                updatedCount++;
-                                return;
-                            }
-                        }
-                        yield this.adminforth.createResourceRecord({
-                            resource: resource,
-                            record: row,
-                            adminUser: adminUser,
-                            extra: { body, query, headers, cookies, requestUrl, response }
-                        });
-                        importedCount++;
-                    }
-                    catch (e) {
-                        errors.push(e.message);
-                    }
-                }))));
-                return { ok: true, importedCount, updatedCount, errors };
+                return this.importCsv(data, {
+                    adminUser,
+                    headers,
+                    response,
+                    extra: { body, query, headers, cookies, requestUrl, response },
+                });
             })
         });
         server.endpoint({
@@ -253,8 +180,7 @@ export default class ImportExport extends AdminForthPlugin {
             path: `/plugin/${this.pluginInstanceId}/import-csv-new-only`,
             request_schema: importCsvBodySchema,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, query, headers, cookies, requestUrl, response }) {
-                const payload = body;
-                const { data } = payload;
+                const { data } = body;
                 if (!data || typeof data !== 'object') {
                     return { ok: false, error: 'Invalid data format. Expected an object with column names as keys and arrays of values as values.' };
                 }
@@ -262,52 +188,19 @@ export default class ImportExport extends AdminForthPlugin {
                 if (!access.ok) {
                     return { ok: false, error: access.error };
                 }
-                const columns = this.getColumnNames(data);
-                const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
-                const { errors, resourceColumns } = this.validateColumns(columns);
-                if (errors.length > 0) {
-                    return { ok: false, errors };
-                }
-                const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
-                const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
-                this.tryToAuditLogAction('import', `Import CSV (new only) with ${Object.keys(data).length} columns`, adminUser, headers);
-                let importedCount = 0;
-                const limit = pLimit(100);
-                yield Promise.all(rows.map((row) => limit(() => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const rowErrors = yield this.isRowValid(row);
-                        if (rowErrors.length > 0) {
-                            errors.push(...rowErrors);
-                            return;
-                        }
-                        if (primaryKeyColumn && row[primaryKeyColumn.name]) {
-                            const existingRecord = yield this.adminforth.resource(this.resourceConfig.resourceId)
-                                .list([Filters.EQ(primaryKeyColumn.name, row[primaryKeyColumn.name])]);
-                            if (existingRecord.length > 0) {
-                                return;
-                            }
-                        }
-                        yield this.adminforth.createResourceRecord({
-                            resource: resource,
-                            record: row,
-                            adminUser: adminUser,
-                            extra: { body, query, headers, cookies, requestUrl, response }
-                        });
-                        importedCount++;
-                    }
-                    catch (e) {
-                        errors.push(e.message);
-                    }
-                }))));
-                return { ok: true, importedCount, errors };
+                return this.importCsvNewOnly(data, {
+                    adminUser,
+                    headers,
+                    extra: { body, query, headers, cookies, requestUrl, response },
+                });
             })
         });
         server.endpoint({
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/check-records`,
             request_schema: importCsvBodySchema,
-            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, response }) {
-                const payload = body;
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser }) {
+                const { data } = body;
                 const access = yield this.ensureAnyAllowed(adminUser, [
                     { source: ActionCheckSource.ListRequest, action: AllowedActionsEnum.list },
                     { source: ActionCheckSource.ShowRequest, action: AllowedActionsEnum.show },
@@ -315,29 +208,198 @@ export default class ImportExport extends AdminForthPlugin {
                 if (!access.ok) {
                     return { ok: false, error: access.error };
                 }
-                const { data } = payload;
-                const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
-                const columns = this.getColumnNames(data);
-                const rows = this.buildRowsFromData(data, columns, undefined, { coerceTypes: false });
-                const primaryKeys = rows
-                    .map(row => primaryKeyColumn ? row[primaryKeyColumn.name] : undefined)
-                    .filter(key => key !== undefined && key !== null && key !== '');
-                const existingRecords = yield this.adminforth
-                    .resource(this.resourceConfig.resourceId)
-                    .list([{
-                        field: primaryKeyColumn.name,
-                        operator: AdminForthFilterOperators.IN,
-                        value: primaryKeys,
-                    }]);
-                return {
-                    ok: true,
-                    total: rows.length,
-                    existingCount: existingRecords.length,
-                    newCount: rows.length - existingRecords.length,
-                };
+                return this.checkRecords(data);
             })
         });
     }
+    /**
+     * Export resource records as CSV-ready data.
+     * Can be called programmatically, e.g. `this.exportCsv(filters, sort)`.
+     */
+    exportCsv(filters_1, sort_1) {
+        return __awaiter(this, arguments, void 0, function* (filters, sort, options = {}) {
+            const { adminUser, headers } = options;
+            const connector = this.adminforth.connectors[this.resourceConfig.dataSource];
+            const data = yield connector.getData({
+                resource: this.resourceConfig,
+                limit: 1e6,
+                offset: 0,
+                filters: connector.validateAndNormalizeInputFilters(filters),
+                sort,
+                getTotals: true,
+            });
+            // prepare data for PapaParse unparse
+            const columns = this.resourceConfig.columns.filter((col) => !col.virtual && !col.backendOnly);
+            const columnsToForceQuote = columns.map(col => {
+                return col.type !== AdminForthDataTypes.FLOAT
+                    && col.type !== AdminForthDataTypes.INTEGER
+                    && col.type !== AdminForthDataTypes.BOOLEAN;
+            });
+            const fields = columns.map((col) => col.name);
+            const rows = data.data.map((row) => {
+                return columns.map((col) => {
+                    var _a;
+                    const value = row[col.name];
+                    if (col.type === AdminForthDataTypes.JSON || ((_a = col.isArray) === null || _a === void 0 ? void 0 : _a.enabled)) {
+                        return value == null ? value : JSON.stringify(value);
+                    }
+                    return value;
+                });
+            });
+            if (adminUser) {
+                this.tryToAuditLogAction('export', `Export CSV with filters: ${JSON.stringify(filters)} and sort: ${JSON.stringify(sort)}. Total records: ${rows.length}`, adminUser, headers);
+            }
+            return {
+                ok: true,
+                data: { fields, data: rows },
+                columnsToForceQuote,
+                exportedCount: data.total,
+            };
+        });
+    }
+    /**
+     * Import records from column-oriented data, creating new records and updating
+     * existing ones (matched by primary key).
+     * Can be called programmatically, e.g. `this.importCsv(data, { adminUser })`.
+     */
+    importCsv(data_1) {
+        return __awaiter(this, arguments, void 0, function* (data, options = {}) {
+            const { adminUser, headers, extra, response } = options;
+            const columns = this.getColumnNames(data);
+            const { errors, resourceColumns } = this.validateColumns(columns);
+            const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
+            if (errors.length > 0) {
+                return { ok: false, errors };
+            }
+            const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+            const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
+            if (adminUser) {
+                this.tryToAuditLogAction('import', `Import CSV with ${Object.keys(data).length} columns`, adminUser, headers);
+            }
+            let importedCount = 0;
+            let updatedCount = 0;
+            const limit = pLimit(100);
+            yield Promise.all(rows.map((row) => limit(() => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const rowErrors = yield this.isRowValid(row);
+                    if (rowErrors.length > 0) {
+                        errors.push(...rowErrors);
+                        return;
+                    }
+                    const recordId = primaryKeyColumn ? row[primaryKeyColumn.name] : undefined;
+                    if (primaryKeyColumn && recordId) {
+                        const existingRecord = yield this.adminforth.resource(this.resourceConfig.resourceId)
+                            .list([Filters.EQ(primaryKeyColumn.name, recordId)]);
+                        if (existingRecord.length > 0) {
+                            const connector = this.adminforth.connectors[resource.dataSource];
+                            const oldRecord = yield connector.getRecordByPrimaryKey(resource, recordId);
+                            if (!oldRecord) {
+                                errors.push(`Record with ${primaryKeyColumn.name} ${recordId} not found`);
+                                return;
+                            }
+                            const { error } = yield this.adminforth.updateResourceRecord({
+                                resource, updates: row, adminUser, oldRecord, recordId, response,
+                                extra,
+                            });
+                            if (error) {
+                                errors.push(error);
+                                return;
+                            }
+                            updatedCount++;
+                            return;
+                        }
+                    }
+                    yield this.adminforth.createResourceRecord({
+                        resource: resource,
+                        record: row,
+                        adminUser: adminUser,
+                        extra,
+                    });
+                    importedCount++;
+                }
+                catch (e) {
+                    errors.push(e.message);
+                }
+            }))));
+            return { ok: true, importedCount, updatedCount, errors };
+        });
+    }
+    /**
+     * Import only records that do not already exist (matched by primary key).
+     * Can be called programmatically, e.g. `this.importCsvNewOnly(data, { adminUser })`.
+     */
+    importCsvNewOnly(data_1) {
+        return __awaiter(this, arguments, void 0, function* (data, options = {}) {
+            const { adminUser, headers, extra } = options;
+            const columns = this.getColumnNames(data);
+            const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
+            const { errors, resourceColumns } = this.validateColumns(columns);
+            if (errors.length > 0) {
+                return { ok: false, errors };
+            }
+            const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+            const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
+            if (adminUser) {
+                this.tryToAuditLogAction('import', `Import CSV (new only) with ${Object.keys(data).length} columns`, adminUser, headers);
+            }
+            let importedCount = 0;
+            const limit = pLimit(100);
+            yield Promise.all(rows.map((row) => limit(() => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const rowErrors = yield this.isRowValid(row);
+                    if (rowErrors.length > 0) {
+                        errors.push(...rowErrors);
+                        return;
+                    }
+                    if (primaryKeyColumn && row[primaryKeyColumn.name]) {
+                        const existingRecord = yield this.adminforth.resource(this.resourceConfig.resourceId)
+                            .list([Filters.EQ(primaryKeyColumn.name, row[primaryKeyColumn.name])]);
+                        if (existingRecord.length > 0) {
+                            return;
+                        }
+                    }
+                    yield this.adminforth.createResourceRecord({
+                        resource: resource,
+                        record: row,
+                        adminUser: adminUser,
+                        extra,
+                    });
+                    importedCount++;
+                }
+                catch (e) {
+                    errors.push(e.message);
+                }
+            }))));
+            return { ok: true, importedCount, errors };
+        });
+    }
+    /**
+     * Check how many of the given records already exist (matched by primary key).
+     * Can be called programmatically, e.g. `this.checkRecords(data)`.
+     */
+    checkRecords(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+            const columns = this.getColumnNames(data);
+            const rows = this.buildRowsFromData(data, columns, undefined, { coerceTypes: false });
+            const primaryKeys = rows
+                .map(row => primaryKeyColumn ? row[primaryKeyColumn.name] : undefined)
+                .filter(key => key !== undefined && key !== null && key !== '');
+            const existingRecords = yield this.adminforth
+                .resource(this.resourceConfig.resourceId)
+                .list([{
+                    field: primaryKeyColumn.name,
+                    operator: AdminForthFilterOperators.IN,
+                    value: primaryKeys,
+                }]);
+            return {
+                ok: true,
+                total: rows.length,
+                existingCount: existingRecords.length,
+                newCount: rows.length - existingRecords.length,
+            };
+        });
+    }
     getColumnNames(data) {
         return Object.keys(data !== null && data !== void 0 ? data : {});
     }