nestjs-export-module 1.0.2 → 1.1.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/dist/data-exporter/dto/data-export-args.dto.d.ts +14 -1
- package/dist/data-exporter/dto/data-export-args.dto.js +9 -1
- package/dist/data-exporter/dto/data-export-args.dto.js.map +1 -1
- package/dist/data-exporter/dto/index.d.ts +1 -0
- package/dist/data-exporter/dto/index.js +1 -0
- package/dist/data-exporter/dto/index.js.map +1 -1
- package/dist/data-exporter/providers/csv/csv.service.d.ts +3 -1
- package/dist/data-exporter/providers/csv/csv.service.js +45 -7
- package/dist/data-exporter/providers/csv/csv.service.js.map +1 -1
- package/dist/data-exporter/providers/excel/excel.service.d.ts +1 -0
- package/dist/data-exporter/providers/excel/excel.service.js +26 -2
- package/dist/data-exporter/providers/excel/excel.service.js.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,20 @@
|
|
|
1
1
|
import { CsvDataExportArgs, ExcelDataExportArgs } from '../providers';
|
|
2
2
|
import { DataExporterType } from '../enum';
|
|
3
|
+
export declare class PaginationArgs {
|
|
4
|
+
limit?: number;
|
|
5
|
+
offset?: number;
|
|
6
|
+
nextCursor?: string;
|
|
7
|
+
data?: Record<string, any>;
|
|
8
|
+
}
|
|
3
9
|
export declare class DataExportBaseArgs {
|
|
4
10
|
type: DataExporterType;
|
|
5
|
-
|
|
11
|
+
paginationOptions?: {
|
|
12
|
+
limit?: number;
|
|
13
|
+
data?: Record<string, any>;
|
|
14
|
+
};
|
|
15
|
+
data: Array<object> | ((args: PaginationArgs) => Promise<{
|
|
16
|
+
data: Array<object>;
|
|
17
|
+
nextCursor?: string;
|
|
18
|
+
}>);
|
|
6
19
|
}
|
|
7
20
|
export type DataExportArgs = CsvDataExportArgs | ExcelDataExportArgs;
|
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DataExportBaseArgs = void 0;
|
|
3
|
+
exports.DataExportBaseArgs = exports.PaginationArgs = void 0;
|
|
4
|
+
class PaginationArgs {
|
|
5
|
+
limit;
|
|
6
|
+
offset;
|
|
7
|
+
nextCursor;
|
|
8
|
+
data;
|
|
9
|
+
}
|
|
10
|
+
exports.PaginationArgs = PaginationArgs;
|
|
4
11
|
class DataExportBaseArgs {
|
|
5
12
|
type;
|
|
13
|
+
paginationOptions;
|
|
6
14
|
data;
|
|
7
15
|
}
|
|
8
16
|
exports.DataExportBaseArgs = DataExportBaseArgs;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-export-args.dto.js","sourceRoot":"","sources":["../../../src/data-exporter/dto/data-export-args.dto.ts"],"names":[],"mappings":";;;AAIA,MAAa,kBAAkB;IAC7B,IAAI,CAAmB;IACvB,IAAI,
|
|
1
|
+
{"version":3,"file":"data-export-args.dto.js","sourceRoot":"","sources":["../../../src/data-exporter/dto/data-export-args.dto.ts"],"names":[],"mappings":";;;AAIA,MAAa,cAAc;IACzB,KAAK,CAAU;IACf,MAAM,CAAU;IAChB,UAAU,CAAU;IACpB,IAAI,CAAuB;CAC5B;AALD,wCAKC;AAED,MAAa,kBAAkB;IAC7B,IAAI,CAAmB;IACvB,iBAAiB,CAGf;IACF,IAAI,CAKI;CACT;AAZD,gDAYC"}
|
|
@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./data-export-result.dto"), exports);
|
|
18
|
+
__exportStar(require("./data-export-args.dto"), exports);
|
|
18
19
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-exporter/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-exporter/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,yDAAuC"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
import { CsvDataExportArgs } from './dto';
|
|
2
1
|
import { DataExportResult } from '../../dto';
|
|
2
|
+
import { CsvDataExportArgs } from './dto';
|
|
3
3
|
import { DataExporterBaseService } from '../../data-exporter-base.service';
|
|
4
4
|
export declare class CsvService extends DataExporterBaseService {
|
|
5
5
|
exportAsync(dataExportArgs: CsvDataExportArgs): Promise<DataExportResult>;
|
|
6
|
+
private exportObject;
|
|
7
|
+
private exportPaginationArgsAsync;
|
|
6
8
|
}
|
|
@@ -14,20 +14,58 @@ const nestjs_factory_pattern_module_1 = require("nestjs-factory-pattern-module")
|
|
|
14
14
|
const common_1 = require("@nestjs/common");
|
|
15
15
|
const json_2_csv_1 = require("json-2-csv");
|
|
16
16
|
let CsvService = class CsvService extends data_exporter_base_service_1.DataExporterBaseService {
|
|
17
|
-
exportAsync(dataExportArgs) {
|
|
18
|
-
|
|
17
|
+
async exportAsync(dataExportArgs) {
|
|
18
|
+
let data;
|
|
19
|
+
if (Array.isArray(dataExportArgs.data)) {
|
|
20
|
+
data = this.exportObject(dataExportArgs.data, dataExportArgs);
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
data = await this.exportPaginationArgsAsync(dataExportArgs);
|
|
24
|
+
}
|
|
25
|
+
return {
|
|
26
|
+
mimeType: 'text/csv',
|
|
27
|
+
extension: 'csv',
|
|
28
|
+
data: data,
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
exportObject(rows, dataExportArgs, includeHeaders = true) {
|
|
32
|
+
const data = (0, json_2_csv_1.json2csv)(rows, {
|
|
19
33
|
keys: dataExportArgs.options?.headers,
|
|
20
34
|
fieldTitleMap: dataExportArgs.options?.headersMap,
|
|
35
|
+
prependHeader: includeHeaders,
|
|
21
36
|
delimiter: {
|
|
22
37
|
field: dataExportArgs.options?.delimiter ?? ',',
|
|
23
38
|
wrap: dataExportArgs.options?.quote,
|
|
24
39
|
},
|
|
25
40
|
});
|
|
26
|
-
return
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
41
|
+
return Buffer.from(data, dataExportArgs.options?.encoding ?? 'utf-8');
|
|
42
|
+
}
|
|
43
|
+
async exportPaginationArgsAsync(dataExportArgs) {
|
|
44
|
+
const limit = dataExportArgs.paginationOptions?.limit ?? 100;
|
|
45
|
+
const encoding = dataExportArgs.options?.encoding ?? 'utf-8';
|
|
46
|
+
const newline = Buffer.from('\n', encoding);
|
|
47
|
+
const chunks = [];
|
|
48
|
+
let offset = 0;
|
|
49
|
+
let result = {
|
|
50
|
+
data: [],
|
|
51
|
+
};
|
|
52
|
+
do {
|
|
53
|
+
result = await dataExportArgs.data({
|
|
54
|
+
limit,
|
|
55
|
+
...(result.nextCursor ? { nextCursor: result.nextCursor } : { offset }),
|
|
56
|
+
...(dataExportArgs?.paginationOptions?.data && {
|
|
57
|
+
data: dataExportArgs?.paginationOptions?.data,
|
|
58
|
+
}),
|
|
59
|
+
});
|
|
60
|
+
if (!result.data.length)
|
|
61
|
+
break;
|
|
62
|
+
const chunk = this.exportObject(result.data, dataExportArgs, offset === 0);
|
|
63
|
+
if (offset !== 0)
|
|
64
|
+
chunks.push(newline);
|
|
65
|
+
chunks.push(chunk);
|
|
66
|
+
offset += limit;
|
|
67
|
+
} while (result.data.length === limit);
|
|
68
|
+
return Buffer.concat(chunks);
|
|
31
69
|
}
|
|
32
70
|
};
|
|
33
71
|
exports.CsvService = CsvService;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"csv.service.js","sourceRoot":"","sources":["../../../../src/data-exporter/providers/csv/csv.service.ts"],"names":[],"mappings":";;;;;;;;;
|
|
1
|
+
{"version":3,"file":"csv.service.js","sourceRoot":"","sources":["../../../../src/data-exporter/providers/csv/csv.service.ts"],"names":[],"mappings":";;;;;;;;;AAGA,+CAA8D;AAC9D,iFAA2E;AAC3E,qCAA8C;AAC9C,iFAAgE;AAChE,2CAA4C;AAC5C,2CAAsC;AAI/B,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,oDAAuB;IACrD,KAAK,CAAC,WAAW,CACf,cAAiC;QAEjC,IAAI,IAAY,CAAC;QACjB,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAC;QAC9D,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,KAAK;YAChB,IAAI,EAAE,IAAI;SACX,CAAC;IACJ,CAAC;IAEO,YAAY,CAClB,IAAmB,EACnB,cAAiC,EACjC,iBAA0B,IAAI;QAE9B,MAAM,IAAI,GAAG,IAAA,qBAAQ,EAAC,IAAI,EAAE;YAC1B,IAAI,EAAE,cAAc,CAAC,OAAO,EAAE,OAAO;YACrC,aAAa,EAAE,cAAc,CAAC,OAAO,EAAE,UAAU;YACjD,aAAa,EAAE,cAAc;YAC7B,SAAS,EAAE;gBACT,KAAK,EAAE,cAAc,CAAC,OAAO,EAAE,SAAS,IAAI,GAAG;gBAC/C,IAAI,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK;aACpC;SACF,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,CAAC,CAAC;IACxE,CAAC;IAEO,KAAK,CAAC,yBAAyB,CACrC,cAAiC;QAEjC,MAAM,KAAK,GAAG,cAAc,CAAC,iBAAiB,EAAE,KAAK,IAAI,GAAG,CAAC;QAC7D,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,CAAC;QAC7D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE5C,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,MAAM,GAAiD;YACzD,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,GAAG,CAAC;YACF,MAAM,GAAG,MACP,cAAc,CAAC,IAGhB,CAAC;gBACA,KAAK;gBACL,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;gBACvE,GAAG,CAAC,cAAc,EAAE,iBAAiB,EAAE,IAAI,IAAI;oBAC7C,IAAI,EAAE,cAAc,EAAE,iBAAiB,EAAE,IAAI;iBAC9C,CAAC;aACH,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM;gBAAE,MAAM;YAE/B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAC7B,MAAM,CAAC,IAAI,EACX,cAAc,EACd,MAAM,KAAK,CAAC,CACb,CAAC;YAEF,IAAI,MAAM,KAAK,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEnB,MAAM,IAAI,KAAK,CAAC;QAClB,CAAC,QAAQ,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE;QAEvC,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;CACF,CAAA;AA9EY,gCAAU;qBAAV,UAAU;IAFtB,IAAA,mBAAU,GAAE;IACZ,IAAA,+CAAe,EAAC,uCAA2B,EAAE,uBAAgB,CAAC,GAAG,CAAC;GACtD,UAAU,CA8EtB"}
|
|
@@ -3,5 +3,6 @@ import { DataExporterBaseService } from '../../data-exporter-base.service';
|
|
|
3
3
|
import { ExcelDataExportArgs } from './dto';
|
|
4
4
|
export declare class ExcelService extends DataExporterBaseService {
|
|
5
5
|
exportAsync(dataExportArgs: ExcelDataExportArgs): Promise<DataExportResult>;
|
|
6
|
+
private addDataToWorksheetAsync;
|
|
6
7
|
private getHeaders;
|
|
7
8
|
}
|
|
@@ -50,8 +50,12 @@ let ExcelService = class ExcelService extends data_exporter_base_service_1.DataE
|
|
|
50
50
|
async exportAsync(dataExportArgs) {
|
|
51
51
|
const workbook = new ExcelJS.Workbook();
|
|
52
52
|
const worksheet = workbook.addWorksheet(dataExportArgs.options?.sheetName ?? 'Sheet1');
|
|
53
|
-
|
|
54
|
-
|
|
53
|
+
if (Array.isArray(dataExportArgs.data)) {
|
|
54
|
+
worksheet.columns = this.getHeaders(dataExportArgs.data.at(0) ?? {}, dataExportArgs.options);
|
|
55
|
+
worksheet.addRows(dataExportArgs.data);
|
|
56
|
+
}
|
|
57
|
+
else
|
|
58
|
+
await this.addDataToWorksheetAsync(dataExportArgs, worksheet);
|
|
55
59
|
const data = await workbook.xlsx.writeBuffer();
|
|
56
60
|
return {
|
|
57
61
|
mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
|
|
@@ -59,6 +63,26 @@ let ExcelService = class ExcelService extends data_exporter_base_service_1.DataE
|
|
|
59
63
|
data: data,
|
|
60
64
|
};
|
|
61
65
|
}
|
|
66
|
+
async addDataToWorksheetAsync(dataExportArgs, worksheet) {
|
|
67
|
+
const limit = dataExportArgs.paginationOptions?.limit ?? 100;
|
|
68
|
+
let offset = 0;
|
|
69
|
+
let result = {
|
|
70
|
+
data: [],
|
|
71
|
+
};
|
|
72
|
+
do {
|
|
73
|
+
result = await dataExportArgs.data({
|
|
74
|
+
limit,
|
|
75
|
+
...(result.nextCursor ? { nextCursor: result.nextCursor } : { offset }),
|
|
76
|
+
...(dataExportArgs?.paginationOptions?.data && {
|
|
77
|
+
data: dataExportArgs?.paginationOptions?.data,
|
|
78
|
+
}),
|
|
79
|
+
});
|
|
80
|
+
if (offset === 0)
|
|
81
|
+
worksheet.columns = this.getHeaders(result.data.at(0) ?? {}, dataExportArgs.options);
|
|
82
|
+
worksheet.addRows(result.data);
|
|
83
|
+
offset += limit;
|
|
84
|
+
} while (result.data.length === limit);
|
|
85
|
+
}
|
|
62
86
|
getHeaders(firstRowData, options) {
|
|
63
87
|
let result = [];
|
|
64
88
|
if (options?.headers)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"excel.service.js","sourceRoot":"","sources":["../../../../src/data-exporter/providers/excel/excel.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;
|
|
1
|
+
{"version":3,"file":"excel.service.js","sourceRoot":"","sources":["../../../../src/data-exporter/providers/excel/excel.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AAInC,+CAA8D;AAC9D,iFAA2E;AAC3E,qCAA8C;AAE9C,iFAAgE;AAChE,2CAA4C;AAIrC,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,oDAAuB;IACvD,KAAK,CAAC,WAAW,CACf,cAAmC;QAEnC,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACxC,MAAM,SAAS,GAAG,QAAQ,CAAC,YAAY,CACrC,cAAc,CAAC,OAAO,EAAE,SAAS,IAAI,QAAQ,CAC9C,CAAC;QAEF,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CACjC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAC/B,cAAc,CAAC,OAAO,CACvB,CAAC;YACF,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;;YAAM,MAAM,IAAI,CAAC,uBAAuB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAErE,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/C,OAAO;YACL,QAAQ,EACN,mEAAmE;YACrE,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,IAAyB;SAChC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACnC,cAAmC,EACnC,SAA4B;QAE5B,MAAM,KAAK,GAAG,cAAc,CAAC,iBAAiB,EAAE,KAAK,IAAI,GAAG,CAAC;QAC7D,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,MAAM,GAAiD;YACzD,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,GAAG,CAAC;YACF,MAAM,GAAG,MACP,cAAc,CAAC,IAGhB,CAAC;gBACA,KAAK;gBACL,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;gBACvE,GAAG,CAAC,cAAc,EAAE,iBAAiB,EAAE,IAAI,IAAI;oBAC7C,IAAI,EAAE,cAAc,EAAE,iBAAiB,EAAE,IAAI;iBAC9C,CAAC;aACH,CAAC,CAAC;YAEH,IAAI,MAAM,KAAK,CAAC;gBACd,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CACjC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EACvB,cAAc,CAAC,OAAO,CACvB,CAAC;YAEJ,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC;QAClB,CAAC,QAAQ,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE;IACzC,CAAC;IAEO,UAAU,CAChB,YAAoB,EACpB,OAAwC;QAExC,IAAI,MAAM,GAAmC,EAAE,CAAC;QAEhD,IAAI,OAAO,EAAE,OAAO;YAClB,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACxC,MAAM,YAAY,GAAG,OAAO,EAAE,aAAa,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5D,OAAO;oBACL,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,IAAI,MAAM;oBAC/C,GAAG,EAAE,MAAM;oBACX,GAAG,YAAY;iBAChB,CAAC;YACJ,CAAC,CAAC,CAAC;;YAEH,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAClD,MAAM,YAAY,GAAG,OAAO,EAAE,aAAa,EAAE,CAAC,QAAQ,CAAC,CAAC;gBACxD,OAAO;oBACL,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,IAAI,QAAQ;oBACnD,GAAG,EAAE,QAAQ;oBACb,GAAG,YAAY;iBAChB,CAAC;YACJ,CAAC,CAAC,CAAC;QAEL,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAvFY,oCAAY;uBAAZ,YAAY;IAFxB,IAAA,mBAAU,GAAE;IACZ,IAAA,+CAAe,EAAC,uCAA2B,EAAE,uBAAgB,CAAC,KAAK,CAAC;GACxD,YAAY,CAuFxB"}
|