identity-admin 1.28.30 → 1.28.32

package/lib/controllers/DashboardController.d.ts

@@ -36,7 +36,7 @@ export default class DashboardController {
     index(req: IRequest, res: Response): Promise<void | Response<any, Record<string, any>>>;
     create(req: IRequest, res: Response): Promise<void>;
     update(req: IRequest, res: Response): Promise<void | Response<any, Record<string, any>>>;
-    report(req: IRequest, res: Response): Promise<void>;
+    report(req: IRequest, res: Response): Promise<void | Response<any, Record<string, any>>>;
     show(req: IRequest, res: Response): Promise<void | Response<any, Record<string, any>>>;
     deleteAll(req: IRequest, res: Response): Promise<void | Response<any, Record<string, any>>>;
     delete(req: IRequest, res: Response): Promise<void | Response<any, Record<string, any>>>;

package/lib/controllers/DashboardController.js

@@ -479,21 +479,27 @@ let DashboardController = DashboardController_1 = class DashboardController {
             if (crudOperations && crudOperations.index && crudOperations.index.before) {
                 filter = yield crudOperations.index.before(req, filter, currentUser);
             }
+            const fields = ReportsGenerator_1.default.parseFields(req.query.fields);
+            if (fields.length === 0) {
+                return ResponseUtils_1.default.send(res, 400, 'fields query parameter is required');
+            }
+            const select = ReportsGenerator_1.default.buildSelect(fields);
+            const columnFieldKeys = ReportsGenerator_1.default.getColumnFieldKeys(fields);
             var records = [];
-            const populatedString = modifiedResource.properties.populatedString;
-            const populationHelper = new PopulationHelper_1.PopulationHelper(resource, PopulationHelper_1.PopulationType.LIST, populatedString);
+            const populatedString = modifiedResource.properties.populatedString
+                .split(' ')
+                .filter((field) => columnFieldKeys.some((key) => field === key || field.startsWith(key + '.')))
+                .join(' ');
+            const populationHelper = new PopulationHelper_1.PopulationHelper(resource, PopulationHelper_1.PopulationType.REPORT, populatedString);
             const modifiedPopulatedObject = yield populationHelper.get();
             records = yield repository.findMany({
                 sort: sortQuery,
                 filter,
                 populate: modifiedPopulatedObject,
+                select,
+                lean: true,
             });
-            var documents = [];
-            for (var i = 0; i < records.length; i++) {
-                const record = records[i];
-                const recordFlatten = record.toObject();
-                documents.push(recordFlatten);
-            }
+            var documents = records;
             if (crudOperations && crudOperations.index && crudOperations.index.after) {
                 try {
                     documents = yield crudOperations.index.after(req, documents, currentUser);
@@ -502,18 +508,15 @@ let DashboardController = DashboardController_1 = class DashboardController {
                     documents = yield crudOperations.index.after(req, records, currentUser);
                 }
             }
-            const fields = req.query.fields.map((v) => JSON.parse(v));
             const fileType = req.query.fileType;
             if (fileType === 'xlsx') {
-                const buffer = ReportsGenerator_1.default.CreateXlsxFile(fields, documents, modelName, language, resource);
                 res.writeHead(200, {
                     'Content-Type': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-                    'Content-disposition': 'attachment;filename=' + `${modelName}.xlsx`,
-                    'Content-Length': buffer.length,
+                    'Content-disposition': `attachment;filename=${modelName}.xlsx`,
                 });
-                res.end(buffer);
+                yield ReportsGenerator_1.default.CreateXlsxStream(fields, documents, modelName, language, resource, res);
             }
-            if (fileType === 'pdf') {
+            else if (fileType === 'pdf') {
                 const buffer = yield ReportsGenerator_1.default.CreatePdfFile(fields, documents, modelName, language, resource);
                 res.writeHead(200, {
                     'Content-Type': 'application/pdf',
@@ -522,6 +525,25 @@ let DashboardController = DashboardController_1 = class DashboardController {
                 });
                 res.end(buffer);
             }
+            else if (fileType === 'csv') {
+                res.writeHead(200, {
+                    'Content-Type': 'text/csv; charset=utf-8',
+                    'Content-disposition': `attachment;filename=${modelName}.csv`,
+                });
+                res.write('\uFEFF');
+                res.write(fields.map((f) => `"${f.label}"`).join(',') + '\r\n');
+                documents.forEach((record) => {
+                    const row = fields.map((f) => {
+                        const val = ReportsGenerator_1.default.getFieldValue(f, record, language, resource);
+                        return `"${String(val !== null && val !== void 0 ? val : '').replace(/"/g, '""')}"`;
+                    }).join(',');
+                    res.write(row + '\r\n');
+                });
+                res.end();
+            }
+            if (!fileType) {
+                return ResponseUtils_1.default.send(res, 400, 'fileType query parameter is required');
+            }
         });
     }
     show(req, res) {

package/lib/helpers/PopulationHelper.d.ts

@@ -1,7 +1,8 @@
 import { IResourceFile } from "../types/IResourceFile";
 export declare enum PopulationType {
     LIST = "LIST",
-    SHOW = "SHOW"
+    SHOW = "SHOW",
+    REPORT = "REPORT"
 }
 export declare class PopulationHelper {
     private resource;

package/lib/helpers/PopulationHelper.js

@@ -14,6 +14,7 @@ var PopulationType;
 (function (PopulationType) {
     PopulationType["LIST"] = "LIST";
     PopulationType["SHOW"] = "SHOW";
+    PopulationType["REPORT"] = "REPORT";
 })(PopulationType = exports.PopulationType || (exports.PopulationType = {}));
 class PopulationHelper {
     constructor(resource, populationType, populatedString) {
@@ -27,7 +28,7 @@ class PopulationHelper {
             if (!populate) {
                 return this.populatedString;
             }
-            if (!populate.all && !populate.list && !populate.show) {
+            if (!populate.all && !populate.list && !populate.show && !populate.report) {
                 return this.populatedString;
             }
             if (populate.all) {
@@ -38,6 +39,14 @@ class PopulationHelper {
                     return yield populate.list(this.populatedString);
                 }
             }
+            else if (this.populationType === PopulationType.REPORT) {
+                if (populate.report) {
+                    return yield populate.report(this.populatedString);
+                }
+                if (populate.list) {
+                    return yield populate.list(this.populatedString);
+                }
+            }
             else {
                 if (populate.show) {
                     return yield populate.show(this.populatedString);

package/lib/helpers/ReportsGenerator.d.ts

@@ -17,10 +17,14 @@ export interface ILanguage {
     value?: string;
 }
 export default class ReportsGenerator {
+    static CreateXlsxStream(columns: Columns[], data: any[], name: string, language: Languages, resource: IResourceFile, stream: any): Promise<void>;
     static CreateXlsxFile(columns: Columns[], data: any[], name: string, language: Languages, resource: IResourceFile): Buffer;
     static CreatePdfFile(columns: Columns[], data: any[], name: string, language: Languages, resource: IResourceFile): Promise<Buffer>;
     static getRows(columns: Columns[], data: any[], language: Languages, resource: IResourceFile): any[][];
     static getFieldValue(field: Columns, row: any, language: Languages, resource: IResourceFile): any;
     static checkLocalizedStringExistence(columns: Columns[]): boolean;
+    static parseFields(queryFields: any): Columns[];
+    static buildSelect(fields: Columns[]): Record<string, number>;
+    static getColumnFieldKeys(fields: Columns[]): string[];
     static getReferenceValueByTitleType(rowValue: any, language: Languages, titleType?: FieldTypes): any;
 }

package/lib/helpers/ReportsGenerator.js

@@ -49,6 +49,24 @@ var Languages;
     Languages["ENGLISH"] = "en";
 })(Languages = exports.Languages || (exports.Languages = {}));
 class ReportsGenerator {
+    static CreateXlsxStream(columns, data, name, language, resource, stream) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ExcelJS = require('exceljs');
+            const workbook = new ExcelJS.stream.xlsx.WorkbookWriter({
+                stream,
+                useStyles: false,
+                useSharedStrings: false,
+            });
+            const worksheet = workbook.addWorksheet(name);
+            worksheet.addRow(columns.map(f => f.label)).commit();
+            data.forEach((record) => {
+                const row = columns.map((f) => this.getFieldValue(f, record, language, resource));
+                worksheet.addRow(row).commit();
+            });
+            worksheet.commit();
+            yield workbook.commit();
+        });
+    }
     static CreateXlsxFile(columns, data, name, language, resource) {
         const header = columns.map((field) => field.label);
         const rows = this.getRows(columns, data, language, resource);
@@ -64,7 +82,6 @@ class ReportsGenerator {
     }
     static CreatePdfFile(columns, data, name, language, resource) {
         return __awaiter(this, void 0, void 0, function* () {
-            const rows = this.getRows(columns, data, language, resource);
             const ArabicFont = new pdfjs_1.default.Font(fs.readFileSync(__dirname + '/../assets/Amiri-Regular.ttf'));
             const localizedStringIsExisted = this.checkLocalizedStringExistence(columns);
             const doc = new pdfjs_1.default.Document({
@@ -85,14 +102,17 @@ class ReportsGenerator {
                 textAlign: 'center',
                 alignment: 'center',
             }));
-            rows.forEach((row) => {
+            data.forEach((record) => {
                 const tableRow = table.row();
-                row.map((cell) => tableRow.cell(`${cell !== null && cell !== void 0 ? cell : '---'}`, {
-                    textAlign: 'center',
-                    alignment: 'center',
-                    paddingBottom: 5,
-                    paddingTop: 5,
-                }));
+                columns.forEach((field) => {
+                    const value = this.getFieldValue(field, record, language, resource);
+                    tableRow.cell(`${value !== null && value !== void 0 ? value : '---'}`, {
+                        textAlign: 'center',
+                        alignment: 'center',
+                        paddingBottom: 5,
+                        paddingTop: 5,
+                    });
+                });
             });
             return yield doc.asBuffer();
         });
@@ -132,6 +152,42 @@ class ReportsGenerator {
     static checkLocalizedStringExistence(columns) {
         return columns.some((column) => column.type === helpers_1.FieldTypes.LOCALIZEDSTRING);
     }
+    static parseFields(queryFields) {
+        if (!queryFields)
+            return [];
+        if (Array.isArray(queryFields)) {
+            return queryFields.map((v) => (typeof v === 'string' ? JSON.parse(v) : v));
+        }
+        return [];
+    }
+    static buildSelect(fields) {
+        const select = {};
+        fields.forEach((field) => {
+            const topField = field.value.split('.')[0];
+            select[topField] = 1;
+            if (field.titlePath) {
+                const topTitlePath = field.titlePath.split('.')[0];
+                select[topTitlePath] = 1;
+            }
+        });
+        return select;
+    }
+    static getColumnFieldKeys(fields) {
+        const keys = [];
+        fields.forEach((field) => {
+            const topField = field.value.split('.')[0];
+            if (!keys.includes(topField)) {
+                keys.push(topField);
+            }
+            if (field.titlePath) {
+                const topTitlePath = field.titlePath.split('.')[0];
+                if (!keys.includes(topTitlePath)) {
+                    keys.push(topTitlePath);
+                }
+            }
+        });
+        return keys;
+    }
     static getReferenceValueByTitleType(rowValue, language, titleType) {
         if (!titleType)
             return rowValue;

package/lib/repositories/Repository.d.ts

@@ -12,6 +12,7 @@ interface IQueryOptions {
     skip?: number;
     paginateParams?: PaginateParams;
     populate?: any;
+    lean?: boolean;
 }
 export interface PageInfo {
     currentPage: number;

package/lib/repositories/Repository.js

@@ -49,6 +49,7 @@ let Repository = Repository_1 = class Repository {
             const limit = this.getLimit(queryOptions);
             const skip = this.getSkip(queryOptions);
             const populate = queryOptions.populate;
+            const lean = queryOptions.lean;
             var query = this.model.find(filter);
             if (select) {
                 query = query.select(select);
@@ -65,6 +66,9 @@ let Repository = Repository_1 = class Repository {
             if (populate) {
                 query = query.populate(populate);
             }
+            if (lean) {
+                query = query.lean();
+            }
             return yield query;
         });
     }

package/lib/types/IResourceFile.d.ts

@@ -36,6 +36,11 @@ interface IPopulate {
      * This function is called for the get one endpoint either in show or form an access over the populated string
      */
     show?: PopulateFunction;
+    /**
+     * This function is called for the report endpoint to have an access over the populated string.
+     * Falls back to populate.list if not defined.
+     */
+    report?: PopulateFunction;
 }
 interface Action {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "identity-admin",
-  "version": "1.28.30",
+  "version": "1.28.32",
   "description": "",
   "main": "lib/Dashboard.js",
   "types": "lib/Dashbord.d.ts",
@@ -50,6 +50,7 @@
     "connect-mongo": "^4.6.0",
     "cookie-parser": "^1.4.6",
     "deep-diff": "^1.0.2",
+    "exceljs": "^4.4.0",
     "express-session": "^1.17.3",
     "lodash": "^4.17.21",
     "memory-cache": "^0.2.0",