@n8n/backend-module-data-table 0.0.0-stage → 0.2.0
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/LICENSE.md +88 -0
- package/LICENSE_EE.md +27 -0
- package/dist/build.tsbuildinfo +1 -0
- package/dist/csv-parser.service.d.ts +34 -0
- package/dist/csv-parser.service.js +179 -0
- package/dist/csv-parser.service.js.map +1 -0
- package/dist/data-table-aggregate.controller.d.ts +14 -0
- package/dist/data-table-aggregate.controller.js +50 -0
- package/dist/data-table-aggregate.controller.js.map +1 -0
- package/dist/data-table-aggregate.service.d.ts +18 -0
- package/dist/data-table-aggregate.service.js +56 -0
- package/dist/data-table-aggregate.service.js.map +1 -0
- package/dist/data-table-column.entity.d.ts +9 -0
- package/dist/data-table-column.entity.js +43 -0
- package/dist/data-table-column.entity.js.map +1 -0
- package/dist/data-table-column.repository.d.ts +39 -0
- package/dist/data-table-column.repository.js +195 -0
- package/dist/data-table-column.repository.js.map +1 -0
- package/dist/data-table-csv-import.service.d.ts +21 -0
- package/dist/data-table-csv-import.service.js +121 -0
- package/dist/data-table-csv-import.service.js.map +1 -0
- package/dist/data-table-events.d.ts +15 -0
- package/dist/data-table-events.js +4 -0
- package/dist/data-table-events.js.map +1 -0
- package/dist/data-table-file-cleanup.service.d.ts +12 -0
- package/dist/data-table-file-cleanup.service.js +83 -0
- package/dist/data-table-file-cleanup.service.js.map +1 -0
- package/dist/data-table-file-cleanup.task.d.ts +13 -0
- package/dist/data-table-file-cleanup.task.js +33 -0
- package/dist/data-table-file-cleanup.task.js.map +1 -0
- package/dist/data-table-permissions.d.ts +2 -0
- package/dist/data-table-permissions.js +10 -0
- package/dist/data-table-permissions.js.map +1 -0
- package/dist/data-table-proxy.service.d.ts +68 -0
- package/dist/data-table-proxy.service.js +218 -0
- package/dist/data-table-proxy.service.js.map +1 -0
- package/dist/data-table-rows.repository.d.ts +37 -0
- package/dist/data-table-rows.repository.js +445 -0
- package/dist/data-table-rows.repository.js.map +1 -0
- package/dist/data-table-size-validator.service.d.ts +18 -0
- package/dist/data-table-size-validator.service.js +87 -0
- package/dist/data-table-size-validator.service.js.map +1 -0
- package/dist/data-table-uploads.controller.d.ts +13 -0
- package/dist/data-table-uploads.controller.js +68 -0
- package/dist/data-table-uploads.controller.js.map +1 -0
- package/dist/data-table.controller.d.ts +89 -0
- package/dist/data-table.controller.js +472 -0
- package/dist/data-table.controller.js.map +1 -0
- package/dist/data-table.entity.d.ts +9 -0
- package/dist/data-table.entity.js +46 -0
- package/dist/data-table.entity.js.map +1 -0
- package/dist/data-table.module.d.ts +10 -0
- package/dist/data-table.module.js +68 -0
- package/dist/data-table.module.js.map +1 -0
- package/dist/data-table.repository.d.ts +42 -0
- package/dist/data-table.repository.js +339 -0
- package/dist/data-table.repository.js.map +1 -0
- package/dist/data-table.service.d.ts +126 -0
- package/dist/data-table.service.js +600 -0
- package/dist/data-table.service.js.map +1 -0
- package/dist/data-table.types.d.ts +3 -0
- package/dist/data-table.types.js +10 -0
- package/dist/data-table.types.js.map +1 -0
- package/dist/errors/data-table-access-denied.error.d.ts +4 -0
- package/dist/errors/data-table-access-denied.error.js +13 -0
- package/dist/errors/data-table-access-denied.error.js.map +1 -0
- package/dist/errors/data-table-column-name-conflict.error.d.ts +4 -0
- package/dist/errors/data-table-column-name-conflict.error.js +13 -0
- package/dist/errors/data-table-column-name-conflict.error.js.map +1 -0
- package/dist/errors/data-table-column-not-found.error.d.ts +4 -0
- package/dist/errors/data-table-column-not-found.error.js +11 -0
- package/dist/errors/data-table-column-not-found.error.js.map +1 -0
- package/dist/errors/data-table-file-upload.error.d.ts +4 -0
- package/dist/errors/data-table-file-upload.error.js +13 -0
- package/dist/errors/data-table-file-upload.error.js.map +1 -0
- package/dist/errors/data-table-name-conflict.error.d.ts +4 -0
- package/dist/errors/data-table-name-conflict.error.js +13 -0
- package/dist/errors/data-table-name-conflict.error.js.map +1 -0
- package/dist/errors/data-table-not-found.error.d.ts +4 -0
- package/dist/errors/data-table-not-found.error.js +11 -0
- package/dist/errors/data-table-not-found.error.js.map +1 -0
- package/dist/errors/data-table-system-column-name-conflict.error.d.ts +4 -0
- package/dist/errors/data-table-system-column-name-conflict.error.js +13 -0
- package/dist/errors/data-table-system-column-name-conflict.error.js.map +1 -0
- package/dist/errors/data-table-validation.error.d.ts +4 -0
- package/dist/errors/data-table-validation.error.js +13 -0
- package/dist/errors/data-table-validation.error.js.map +1 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.js +41 -0
- package/dist/index.js.map +1 -0
- package/dist/multer-upload-middleware.d.ts +22 -0
- package/dist/multer-upload-middleware.js +145 -0
- package/dist/multer-upload-middleware.js.map +1 -0
- package/dist/persistence/data-table-ddl.d.ts +13 -0
- package/dist/persistence/data-table-ddl.js +77 -0
- package/dist/persistence/data-table-ddl.js.map +1 -0
- package/dist/register-favorite-resolver.d.ts +1 -0
- package/dist/register-favorite-resolver.js +18 -0
- package/dist/register-favorite-resolver.js.map +1 -0
- package/dist/test-utils/data-table.d.ts +2 -0
- package/dist/test-utils/data-table.js +16 -0
- package/dist/test-utils/data-table.js.map +1 -0
- package/dist/testing.d.ts +1 -0
- package/dist/testing.js +6 -0
- package/dist/testing.js.map +1 -0
- package/dist/types.d.ts +12 -0
- package/dist/types.js +7 -0
- package/dist/types.js.map +1 -0
- package/dist/utils/pair-columns.d.ts +27 -0
- package/dist/utils/pair-columns.js +48 -0
- package/dist/utils/pair-columns.js.map +1 -0
- package/dist/utils/sql-utils.d.ts +23 -0
- package/dist/utils/sql-utils.js +284 -0
- package/dist/utils/sql-utils.js.map +1 -0
- package/package.json +98 -3
- package/README.md +0 -3
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import './data-table-events';
|
|
2
|
+
import type { AddDataTableColumnDto, CreateDataTableDto, DeleteDataTableRowsDto, ListDataTableContentQueryDto, MoveDataTableColumnDto, RenameDataTableColumnDto, DataTableListOptions, UpsertDataTableRowDto, UpdateDataTableDto, UpdateDataTableRowDto } from '@n8n/api-types';
|
|
3
|
+
import { Logger, ModuleRegistry } from '@n8n/backend-common';
|
|
4
|
+
import { EventService, ProjectScopeService, RoleService } from '@n8n/backend-services';
|
|
5
|
+
import { ProjectRelationRepository, ProjectRepository, TransactionRunner, type User } from '@n8n/db';
|
|
6
|
+
import { type Scope } from '@n8n/permissions';
|
|
7
|
+
import type { DataTableFilter, DataTableRow, DataTableRowReturn, DataTableRows, DataTableInsertRowsReturnType, DataTableInsertRowsResult, DataTablesSizeResult, DataTableRowReturnWithState } from 'n8n-workflow';
|
|
8
|
+
import { DataTableColumn } from './data-table-column.entity';
|
|
9
|
+
import { DataTableColumnRepository } from './data-table-column.repository';
|
|
10
|
+
import { DataTableCsvImportService } from './data-table-csv-import.service';
|
|
11
|
+
import { DataTableRowsRepository } from './data-table-rows.repository';
|
|
12
|
+
import { DataTableSizeValidator } from './data-table-size-validator.service';
|
|
13
|
+
import type { DataTable } from './data-table.entity';
|
|
14
|
+
import { DataTableRepository } from './data-table.repository';
|
|
15
|
+
export declare class DataTableService {
|
|
16
|
+
private readonly dataTableRepository;
|
|
17
|
+
private readonly dataTableColumnRepository;
|
|
18
|
+
private readonly dataTableRowsRepository;
|
|
19
|
+
private readonly logger;
|
|
20
|
+
private readonly dataTableSizeValidator;
|
|
21
|
+
private readonly projectRelationRepository;
|
|
22
|
+
private readonly roleService;
|
|
23
|
+
private readonly csvImportService;
|
|
24
|
+
private readonly eventService;
|
|
25
|
+
private readonly projectRepository;
|
|
26
|
+
private readonly projectScopeService;
|
|
27
|
+
private readonly moduleRegistry;
|
|
28
|
+
private readonly transactionRunner;
|
|
29
|
+
constructor(dataTableRepository: DataTableRepository, dataTableColumnRepository: DataTableColumnRepository, dataTableRowsRepository: DataTableRowsRepository, logger: Logger, dataTableSizeValidator: DataTableSizeValidator, projectRelationRepository: ProjectRelationRepository, roleService: RoleService, csvImportService: DataTableCsvImportService, eventService: EventService, projectRepository: ProjectRepository, projectScopeService: ProjectScopeService, moduleRegistry: ModuleRegistry, transactionRunner: TransactionRunner);
|
|
30
|
+
start(): Promise<void>;
|
|
31
|
+
shutdown(): Promise<void>;
|
|
32
|
+
getProjectIdForDataTable(dataTableId: string): Promise<string>;
|
|
33
|
+
getOne(dataTableId: string, projectId: string): Promise<DataTable>;
|
|
34
|
+
assertRowReadAccessIfReturningRows(user: User, dataTableId: string, { dryRun, returnData }: {
|
|
35
|
+
dryRun?: boolean;
|
|
36
|
+
returnData?: boolean;
|
|
37
|
+
}): Promise<void>;
|
|
38
|
+
assertProjectExists(projectId: string): Promise<void>;
|
|
39
|
+
resolveOwningProjectId(user: User, projectId?: string): Promise<string>;
|
|
40
|
+
createDataTable(projectId: string, dto: CreateDataTableDto, id?: string, columnIds?: Array<string | undefined>): Promise<DataTable>;
|
|
41
|
+
findDataTablesByIds(dataTableIds: string[]): Promise<DataTable[]>;
|
|
42
|
+
findTableIdsByColumnIds(columnIds: string[]): Promise<Array<Pick<DataTableColumn, 'id' | 'dataTableId'>>>;
|
|
43
|
+
findDataTablesByNamesInProject(projectId: string, names: string[]): Promise<Array<Pick<DataTable, 'id' | 'name'>>>;
|
|
44
|
+
importCsvToExistingTable(dataTableId: string, projectId: string, fileId: string): Promise<{
|
|
45
|
+
importedRowCount: number;
|
|
46
|
+
systemColumnsIgnored: string[];
|
|
47
|
+
}>;
|
|
48
|
+
updateDataTable(dataTableId: string, projectId: string, dto: UpdateDataTableDto): Promise<boolean>;
|
|
49
|
+
transferDataTablesByProjectId(fromProjectId: string, toProjectId: string): Promise<boolean>;
|
|
50
|
+
deleteDataTableByProjectId(projectId: string): Promise<boolean>;
|
|
51
|
+
deleteDataTableAll(): Promise<boolean>;
|
|
52
|
+
deleteDataTable(dataTableId: string, projectId: string): Promise<boolean>;
|
|
53
|
+
addColumn(dataTableId: string, projectId: string, dto: AddDataTableColumnDto): Promise<DataTableColumn>;
|
|
54
|
+
replaceSchema(dataTableId: string, projectId: string, schema: {
|
|
55
|
+
name: string;
|
|
56
|
+
columns: Array<Pick<DataTableColumn, 'name' | 'type'> & {
|
|
57
|
+
id?: string;
|
|
58
|
+
}>;
|
|
59
|
+
}): Promise<void>;
|
|
60
|
+
moveColumn(dataTableId: string, projectId: string, columnId: string, dto: MoveDataTableColumnDto): Promise<boolean>;
|
|
61
|
+
deleteColumn(dataTableId: string, projectId: string, columnId: string): Promise<boolean>;
|
|
62
|
+
renameColumn(dataTableId: string, projectId: string, columnId: string, dto: RenameDataTableColumnDto): Promise<{
|
|
63
|
+
id: string;
|
|
64
|
+
generateId(): void;
|
|
65
|
+
createdAt: Date;
|
|
66
|
+
updatedAt: Date;
|
|
67
|
+
setUpdateDate(): void;
|
|
68
|
+
dataTableId: string;
|
|
69
|
+
type: 'string' | 'number' | 'boolean' | 'date';
|
|
70
|
+
index: number;
|
|
71
|
+
dataTable: DataTable;
|
|
72
|
+
name: string;
|
|
73
|
+
}>;
|
|
74
|
+
getManyAndCount(options: DataTableListOptions): Promise<{
|
|
75
|
+
count: number;
|
|
76
|
+
data: DataTable[];
|
|
77
|
+
}>;
|
|
78
|
+
getManyRowsAndCount(dataTableId: string, projectId: string, dto: ListDataTableContentQueryDto): Promise<{
|
|
79
|
+
count: number;
|
|
80
|
+
data: import("n8n-workflow").DataTableRowsReturn;
|
|
81
|
+
}>;
|
|
82
|
+
getColumns(dataTableId: string, projectId: string): Promise<DataTableColumn[]>;
|
|
83
|
+
getColumnById({ projectId, dataTableId, columnId, }: {
|
|
84
|
+
projectId: string;
|
|
85
|
+
dataTableId: string;
|
|
86
|
+
columnId: string;
|
|
87
|
+
}): Promise<DataTableColumn>;
|
|
88
|
+
insertRows<T extends DataTableInsertRowsReturnType = 'count'>(dataTableId: string, projectId: string, rows: DataTableRows, returnType?: T): Promise<DataTableInsertRowsResult<T>>;
|
|
89
|
+
upsertRow(dataTableId: string, projectId: string, dto: Omit<UpsertDataTableRowDto, 'returnData' | 'dryRun'>, returnData: true, dryRun?: boolean): Promise<DataTableRowReturn[] | DataTableRowReturnWithState[]>;
|
|
90
|
+
upsertRow(dataTableId: string, projectId: string, dto: Omit<UpsertDataTableRowDto, 'returnData' | 'dryRun'>, returnData?: boolean, dryRun?: true): Promise<DataTableRowReturnWithState[]>;
|
|
91
|
+
upsertRow(dataTableId: string, projectId: string, dto: Omit<UpsertDataTableRowDto, 'returnData' | 'dryRun'>, returnData?: false, dryRun?: false): Promise<true>;
|
|
92
|
+
upsertRow(dataTableId: string, projectId: string, dto: Omit<UpsertDataTableRowDto, 'returnData' | 'dryRun'>, returnData: boolean, dryRun: boolean): Promise<DataTableRowReturn[] | DataTableRowReturnWithState[] | true>;
|
|
93
|
+
validateAndTransformUpdateParams({ filter, data }: Pick<UpdateDataTableRowDto, 'filter' | 'data'>, columns: DataTableColumn[]): {
|
|
94
|
+
data: DataTableRow;
|
|
95
|
+
filter: DataTableFilter;
|
|
96
|
+
};
|
|
97
|
+
updateRows(dataTableId: string, projectId: string, dto: Omit<UpdateDataTableRowDto, 'returnData' | 'dryRun'>, returnData: true, dryRun?: boolean): Promise<DataTableRowReturn[] | DataTableRowReturnWithState[]>;
|
|
98
|
+
updateRows(dataTableId: string, projectId: string, dto: Omit<UpdateDataTableRowDto, 'returnData' | 'dryRun'>, returnData?: boolean, dryRun?: true): Promise<DataTableRowReturnWithState[]>;
|
|
99
|
+
updateRows(dataTableId: string, projectId: string, dto: Omit<UpdateDataTableRowDto, 'returnData' | 'dryRun'>, returnData?: false, dryRun?: false): Promise<true>;
|
|
100
|
+
updateRows(dataTableId: string, projectId: string, dto: Omit<UpdateDataTableRowDto, 'returnData' | 'dryRun'>, returnData: boolean, dryRun: boolean): Promise<DataTableRowReturn[] | DataTableRowReturnWithState[] | true>;
|
|
101
|
+
deleteRows(dataTableId: string, projectId: string, dto: Omit<DeleteDataTableRowsDto, 'returnData' | 'dryRun'>, returnData: true, dryRun?: boolean): Promise<DataTableRowReturn[]>;
|
|
102
|
+
deleteRows(dataTableId: string, projectId: string, dto: Omit<DeleteDataTableRowsDto, 'returnData' | 'dryRun'>, returnData?: boolean, dryRun?: true): Promise<DataTableRowReturn[]>;
|
|
103
|
+
deleteRows(dataTableId: string, projectId: string, dto: Omit<DeleteDataTableRowsDto, 'returnData' | 'dryRun'>, returnData?: false, dryRun?: false): Promise<true>;
|
|
104
|
+
deleteRows(dataTableId: string, projectId: string, dto: Omit<DeleteDataTableRowsDto, 'returnData' | 'dryRun'>, returnData: boolean, dryRun: boolean): Promise<DataTableRowReturn[] | true>;
|
|
105
|
+
clearRows(dataTableId: string, projectId: string): Promise<{
|
|
106
|
+
deletedCount: number;
|
|
107
|
+
}>;
|
|
108
|
+
private validateAndTransformRows;
|
|
109
|
+
private validateAndTransformCell;
|
|
110
|
+
validateDataTableExists(dataTableId: string, projectId: string): Promise<DataTable>;
|
|
111
|
+
private validateColumnExists;
|
|
112
|
+
private validateUniqueName;
|
|
113
|
+
private validateAndTransformFilters;
|
|
114
|
+
private validateDataTableSize;
|
|
115
|
+
getDataTablesSize(user: User): Promise<DataTablesSizeResult>;
|
|
116
|
+
getCachedSizeBytesByIds(dataTableIds: string[]): Promise<Map<string, number>>;
|
|
117
|
+
findDataTablesByIdsForUser(dataTableIds: string[], user: User, scopes: Scope[]): Promise<DataTable[]>;
|
|
118
|
+
generateDataTableCsv(dataTableId: string, projectId: string, includeSystemColumns?: boolean): Promise<{
|
|
119
|
+
csvContent: string;
|
|
120
|
+
dataTableName: string;
|
|
121
|
+
}>;
|
|
122
|
+
private buildCsvContent;
|
|
123
|
+
private formatValueForCsv;
|
|
124
|
+
private formatDateForCsv;
|
|
125
|
+
private escapeCsvValue;
|
|
126
|
+
}
|