identity-admin 1.25.17 → 1.25.19

package/lib/controllers/DashboardController.d.ts

@@ -34,6 +34,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>;
     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

@@ -37,6 +37,7 @@ const LocalizedStringHelper_1 = __importDefault(require("../helpers/LocalizedStr
 const ActionsGenerator_1 = __importDefault(require("../helpers/ActionsGenerator"));
 const helpers_1 = require("../types/helpers");
 const PopulationHelper_1 = require("../helpers/PopulationHelper");
+const ReportsGenerator_1 = __importDefault(require("../helpers/ReportsGenerator"));
 let DashboardController = DashboardController_1 = class DashboardController {
     constructor(resource, repository, resources, modelConfigurations) {
         this.resource = resource;
@@ -355,6 +356,108 @@ let DashboardController = DashboardController_1 = class DashboardController {
             });
         });
     }
+    report(req, res) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.validateRequest(req, res)) {
+                return;
+            }
+            const searchableSubString = req.query.filter
+                ? new RegExp(req.query.filter, "i")
+                : undefined;
+            const scope = req.query.scope;
+            const currentUser = req.user;
+            const modelName = req.params.resource;
+            const filtersQuery = req.query.filters;
+            const filters = filtersQuery
+                ? filtersQuery.split("^^")
+                : undefined;
+            const resource = (_a = this.resource) !== null && _a !== void 0 ? _a : (0, ResourceUtils_1.getResource)(modelName, (_b = this.resources) !== null && _b !== void 0 ? _b : []);
+            if (!resource) {
+                return ResponseUtils_1.default.notFound(res, "Resource not found", []);
+            }
+            if (!currentUser) {
+                return ResponseUtils_1.default.unauthorized(res);
+            }
+            const permissionCheck = resource.properties.isAllowed
+                ? yield resource.properties.isAllowed(currentUser)
+                : true;
+            if (!permissionCheck) {
+                return ResponseUtils_1.default.forbidden(res);
+            }
+            const repository = (_c = this.repository) !== null && _c !== void 0 ? _c : new Repository_1.default(resource.properties.resource);
+            const modifiedResource = ResourceGenerator_1.default.generate(resource, currentUser, undefined, this.modelConfigurations);
+            const sort = req.query.order;
+            const sortBy = req.query.orderBy;
+            const sortQuery = {};
+            sortQuery[sortBy] = sort;
+            if (sortBy !== "_id") {
+                sortQuery._id = "asc";
+            }
+            var filter = {};
+            if (scope &&
+                resource.properties.filters &&
+                resource.properties.filters.scopes &&
+                resource.properties.filters.scopes.isAccessible) {
+                if (resource.properties.filters.scopes.manual) {
+                    filter = yield resource.properties.filters.scopes.manual.handler(filter, scope, currentUser);
+                }
+                else if (resource.properties.filters.scopes.auto) {
+                    const key = resource.properties.filters.scopes.auto.key;
+                    if (key) {
+                        filter[key] = scope;
+                    }
+                }
+            }
+            if (searchableSubString) {
+                filter = this.getSearchableSubStringFilter(resource, filter, searchableSubString);
+            }
+            filter = yield FiltersHelper_1.default.appendFilters(filter, filters, resource);
+            const crudOperations = resource.properties.crudOperations;
+            if (crudOperations && crudOperations.index && crudOperations.index.before) {
+                filter = yield crudOperations.index.before(req, filter, currentUser);
+            }
+            var records = [];
+            const populatedString = modifiedResource.properties.populatedString;
+            const populationHelper = new PopulationHelper_1.PopulationHelper(resource, PopulationHelper_1.PopulationType.LIST, populatedString);
+            const modifiedPopulatedObject = yield populationHelper.get();
+            records = yield repository.findMany({
+                sort: sortQuery,
+                filter,
+                populate: modifiedPopulatedObject,
+            });
+            var documents = [];
+            var documents = [];
+            for (var i = 0; i < records.length; i++) {
+                const record = records[i];
+                const recordFlatten = record.toObject();
+                documents.push(recordFlatten);
+            }
+            if (crudOperations && crudOperations.index && crudOperations.index.after) {
+                documents = yield crudOperations.index.after(req, documents, 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);
+                res.writeHead(200, {
+                    'Content-Type': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+                    'Content-disposition': 'attachment;filename=' + `${modelName}.xlsx`,
+                    'Content-Length': buffer.length,
+                });
+                res.end(buffer);
+            }
+            if (fileType === 'pdf') {
+                const buffer = yield ReportsGenerator_1.default.CreatePdfFile(fields, documents, modelName);
+                res.writeHead(200, {
+                    'Content-Type': 'application/pdf',
+                    'Content-disposition': 'attachment;filename=' + `${modelName}.pdf`,
+                    'Content-Length': buffer.length,
+                });
+                res.end(buffer);
+            }
+        });
+    }
     show(req, res) {
         var _a, _b, _c, _d, _e;
         return __awaiter(this, void 0, void 0, function* () {
@@ -572,6 +675,11 @@ __decorate([
     __param(0, (0, inversify_express_utils_1.request)()),
     __param(1, (0, inversify_express_utils_1.response)())
 ], DashboardController.prototype, "update", null);
+__decorate([
+    (0, inversify_express_utils_1.httpGet)("/report"),
+    __param(0, (0, inversify_express_utils_1.request)()),
+    __param(1, (0, inversify_express_utils_1.response)())
+], DashboardController.prototype, "report", null);
 __decorate([
     (0, inversify_express_utils_1.httpGet)("/:id"),
     __param(0, (0, inversify_express_utils_1.request)()),

package/lib/controllers/ResourceController.js

@@ -58,12 +58,14 @@ let ResourceController = class ResourceController {
         this.PermissionModel = PermissionModel;
     }
     index(req, res) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             var modifiedResource = {};
             modifiedResource.modelParents = {};
             const currentUser = req.user;
             if (this.configurations) {
                 modifiedResource.appConfigurations = this.configurations;
+                modifiedResource.appConfigurations.showMainActions = (_a = modifiedResource.appConfigurations.showMainActions) !== null && _a !== void 0 ? _a : true;
             }
             for (var i = 0; i < this.resourceFiles.length; i++) {
                 const resource = this.resourceFiles[i];

package/lib/helpers/ActionsGenerator.js

@@ -72,16 +72,18 @@ class ActionsGenerator {
         return extraActionsObject;
     }
     static getActions(actions, currentUser, configuration) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         var actionObject = {
             show: {
                 isAccessible: ((_a = configuration === null || configuration === void 0 ? void 0 : configuration.actions) === null || _a === void 0 ? void 0 : _a.show) === false ? false : true,
+                isMainAction: true
             },
             new: {
                 isAccessible: ((_b = configuration === null || configuration === void 0 ? void 0 : configuration.actions) === null || _b === void 0 ? void 0 : _b.new) === false ? false : true,
             },
             edit: {
                 isAccessible: ((_c = configuration === null || configuration === void 0 ? void 0 : configuration.actions) === null || _c === void 0 ? void 0 : _c.edit) === false ? false : true,
+                isMainAction: true
             },
             delete: {
                 isAccessible: ((_d = configuration === null || configuration === void 0 ? void 0 : configuration.actions) === null || _d === void 0 ? void 0 : _d.delete) === false ? false : true,
@@ -106,6 +108,8 @@ class ActionsGenerator {
                 actionObject[key] = actions[key];
             }
             actionObject[key].reloadAfterAction = (_f = actions[key]) === null || _f === void 0 ? void 0 : _f.reloadAfterAction;
+            actionObject[key].isMainAction =
+                (_g = actions[key].isMainAction) !== null && _g !== void 0 ? _g : (key === "edit" || key === "show");
         }
         return actionObject;
     }

package/lib/helpers/ReportsGenerator.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { FieldTypes } from '../types/helpers';
+export interface Columns {
+    label: string;
+    value: string;
+    type: FieldTypes;
+}
+export default class ReportsGenerator {
+    static CreateXlsxFile(columns: Columns[], data: any[], name: string): Buffer;
+    static CreatePdfFile(columns: Columns[], data: any[], name: string): Promise<Buffer>;
+}

package/lib/helpers/ReportsGenerator.js

@@ -0,0 +1,43 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_xlsx_1 = __importDefault(require("node-xlsx"));
+const lodash_1 = require("lodash");
+const helpers_1 = require("../types/helpers");
+const renderer_1 = require("@react-pdf/renderer");
+const ReportTemplate_1 = __importDefault(require("../pdf/ReportTemplate"));
+class ReportsGenerator {
+    static CreateXlsxFile(columns, data, name) {
+        const header = columns.map((field) => field.label);
+        const rows = data.map((row) => columns.map((field) => (field.type === helpers_1.FieldTypes.OBJECTID ? (0, lodash_1.get)(row, field.value).toString() : (0, lodash_1.get)(row, field.value))));
+        const sheets = [
+            {
+                name,
+                data: [header, ...rows],
+                options: {},
+            },
+        ];
+        const buffer = node_xlsx_1.default.build(sheets);
+        return buffer;
+    }
+    static CreatePdfFile(columns, data, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const header = columns.map((field) => field.label);
+            const rows = data.map((row) => columns.map((field) => (field.type === helpers_1.FieldTypes.OBJECTID ? (0, lodash_1.get)(row, field.value).toString() : (0, lodash_1.get)(row, field.value))));
+            const pdf = yield (0, renderer_1.renderToBuffer)((0, ReportTemplate_1.default)({ columns: header, rows }));
+            return pdf;
+        });
+    }
+}
+exports.default = ReportsGenerator;

package/lib/helpers/RportsGenerator.d.ts

@@ -0,0 +1,10 @@
+import { FieldTypes } from "../types/helpers";
+interface Columns {
+    label: string;
+    value: string;
+    type: FieldTypes;
+}
+export default class ReportsGenerator {
+    static CreateXlsxFile(columns: Columns[], data: any[], name: string): void;
+}
+export {};

package/lib/helpers/RportsGenerator.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_xlsx_1 = __importDefault(require("node-xlsx"));
+const lodash_1 = require("lodash");
+const helpers_1 = require("../types/helpers");
+class ReportsGenerator {
+    static CreateXlsxFile(columns, data, name) {
+        const header = columns.map(field => field.label);
+        const rows = data.map(row => columns.map(field => field.type === helpers_1.FieldTypes.OBJECTID ? (0, lodash_1.get)(row, field.value).toString() : (0, lodash_1.get)(row, field.value)));
+        const sheets = [{
+                name,
+                data: [header, ...rows],
+                options: {}
+            }];
+        const buffer = node_xlsx_1.default.build(sheets);
+    }
+}
+exports.default = ReportsGenerator;

package/lib/pdf/ReportTemplate.d.ts

@@ -0,0 +1,71 @@
+import React from 'react';
+export declare const styles: {
+    table: {
+        display: "flex";
+        width: string;
+        borderStyle: "solid";
+        borderWidth: number;
+        borderRightWidth: number;
+        borderBottomWidth: number;
+    };
+    tableRow: {
+        width: string;
+        margin: string;
+        flexDirection: "row";
+    };
+    tableCol: {
+        width: string;
+        borderStyle: "solid";
+        borderWidth: number;
+        borderLeftWidth: number;
+        borderTopWidth: number;
+    };
+    tableCell: {
+        width: string;
+        margin: string;
+        marginTop: number;
+        fontSize: number;
+        overflow: "hidden";
+    };
+    flexRow: {
+        display: "flex";
+        flexDirection: "row";
+        alignItems: "flex-start";
+        alignContent: "flex-start";
+        justifyContent: "flex-start";
+        marginTop: string;
+    };
+    detailsTitle: {
+        fontSize: string;
+        textAlign: "left";
+        color: string;
+        fontWeight: number;
+        marginBottom: string;
+    };
+    detailsBody: {
+        fontSize: string;
+        textAlign: "left";
+        color: string;
+        fontWeight: number;
+        marginBottom: string;
+    };
+    flexColumn: {
+        display: "flex";
+        flexDirection: "column";
+        alignItems: "flex-start";
+        alignContent: "flex-start";
+        justifyContent: "flex-start";
+    };
+    flexWrap: {
+        flexWrap: "wrap";
+    };
+    borderTopBottom: {
+        borderTop: string;
+        borderBottom: string;
+        padding: string;
+    };
+};
+export default function ReportTemplate({ columns, rows }: {
+    columns: string[];
+    rows: any[][];
+}): React.JSX.Element;

package/lib/pdf/ReportTemplate.js

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.styles = void 0;
+const react_1 = __importDefault(require("react"));
+const renderer_1 = require("@react-pdf/renderer");
+exports.styles = renderer_1.StyleSheet.create({
+    table: {
+        display: 'flex',
+        width: 'auto',
+        borderStyle: 'solid',
+        borderWidth: 1,
+        borderRightWidth: 0,
+        borderBottomWidth: 0,
+    },
+    tableRow: {
+        width: '100%',
+        margin: 'auto',
+        flexDirection: 'row',
+    },
+    tableCol: {
+        width: '100%',
+        borderStyle: 'solid',
+        borderWidth: 1,
+        borderLeftWidth: 0,
+        borderTopWidth: 0,
+    },
+    tableCell: {
+        width: '100%',
+        margin: 'auto',
+        marginTop: 5,
+        fontSize: 18,
+        overflow: 'hidden'
+    },
+    flexRow: {
+        display: 'flex',
+        flexDirection: 'row',
+        alignItems: 'flex-start',
+        alignContent: 'flex-start',
+        justifyContent: 'flex-start',
+        marginTop: '24t',
+    },
+    detailsTitle: {
+        fontSize: '18',
+        textAlign: 'left',
+        color: '#637381',
+        fontWeight: 500,
+        marginBottom: '8',
+    },
+    detailsBody: {
+        fontSize: '18',
+        textAlign: 'left',
+        color: '#000',
+        fontWeight: 500,
+        marginBottom: '8',
+    },
+    flexColumn: {
+        display: 'flex',
+        flexDirection: 'column',
+        alignItems: 'flex-start',
+        alignContent: 'flex-start',
+        justifyContent: 'flex-start',
+    },
+    flexWrap: {
+        flexWrap: 'wrap',
+    },
+    borderTopBottom: {
+        borderTop: '2px solid #000',
+        borderBottom: '2px solid #000',
+        padding: '10px',
+    },
+});
+function ReportTemplate({ columns, rows }) {
+    return (react_1.default.createElement(renderer_1.Document, null,
+        react_1.default.createElement(renderer_1.Page, { size: "A2", orientation: "landscape", style: {
+                padding: '4pt',
+                paddingTop: '8pt',
+            } },
+            react_1.default.createElement(renderer_1.View, { style: [exports.styles.flexRow, { marginTop: '8pt', marginBottom: '16pt', marginLeft: '48pt', marginRight: '64pt', justifyContent: 'space-between', alignItems: 'center' }] },
+                react_1.default.createElement(renderer_1.Image, { style: {
+                        width: 'auto',
+                        height: '32px',
+                    }, src: `public/logo.png` })),
+            react_1.default.createElement(renderer_1.View, { style: exports.styles.table },
+                react_1.default.createElement(renderer_1.View, { style: Object.assign(Object.assign({}, exports.styles.tableRow), { backgroundColor: 'black', color: 'white' }) }, columns.map((column) => (react_1.default.createElement(renderer_1.View, { style: exports.styles.tableCol, key: column },
+                    react_1.default.createElement(renderer_1.Text, { style: exports.styles.tableCell }, column))))),
+                rows.map((row, index) => {
+                    return (react_1.default.createElement(renderer_1.View, { style: exports.styles.tableRow, key: index }, row.map((cell) => (react_1.default.createElement(renderer_1.View, { style: exports.styles.tableCol, key: index * 10 },
+                        react_1.default.createElement(renderer_1.Text, { style: [exports.styles.tableCell] }, `${cell}`))))));
+                })))));
+}
+exports.default = ReportTemplate;

package/lib/types/IConfigurationFile.d.ts

@@ -2,5 +2,8 @@ declare type sizeTypes = 'small' | 'medium';
 export interface IConfiguartionFile {
     textFieldSize?: sizeTypes;
     defaultRowsPerPage?: number;
+    themeLayout?: 'mini' | 'vertical' | 'horizontal';
+    themeStretch?: boolean;
+    showMainActions?: boolean;
 }
 export {};

package/lib/types/IResourceFile.d.ts

@@ -55,6 +55,11 @@ interface Action {
      * @default 'Same as isAccessible'
      */
     isAllowed?: (currentUser: Document) => boolean;
+    /**
+     * The property that manages which action will be extracted from action menu in list.
+     * @default true for edit and show false for others
+     */
+    isMainAction?: boolean;
 }
 interface ICrudOperations {
     index?: {
@@ -421,6 +426,11 @@ export interface ExtraAction {
      * {@link https://mui.com/material-ui/material-icons/}
      */
     handlerStrategy?: HandlerStrategy;
+    /**
+     * The property that manages which action will be extracted from action menu in list.
+     * @default true for edit and show false for others
+     */
+    isMainAction?: boolean;
 }
 export interface IActionHandlerResponse {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "identity-admin",
-  "version": "1.25.17",
+  "version": "1.25.19",
   "description": "",
   "main": "lib/Dashboard.js",
   "types": "lib/Dashbord.d.ts",
@@ -26,8 +26,10 @@
   "devDependencies": {
     "@types/express": "^4.17.14",
     "@types/i18n": "^0.13.4",
+    "@types/lodash": "^4.14.202",
     "@types/mongoose": "^5.11.97",
     "@types/passport-local-mongoose": "^6.1.1",
+    "@types/react": "^18.2.45",
     "express": "^4.18.1",
     "express-validator": "^6.14.2",
     "i18n": "^0.15.0",
@@ -39,13 +41,17 @@
     "reflect-metadata": "^0.1.13"
   },
   "dependencies": {
+    "@react-pdf/renderer": "^3.1.14",
     "@types/express-session": "^1.17.5",
     "bcryptjs": "^2.4.3",
     "connect-mongo": "^4.6.0",
     "cookie-parser": "^1.4.6",
     "express-session": "^1.17.3",
+    "lodash": "^4.17.21",
+    "node-xlsx": "^0.21.0",
     "passport": "^0.6.0",
     "passport-local": "^1.0.0",
-    "pluralize": "^8.0.0"
+    "pluralize": "^8.0.0",
+    "typescript": "^4.7.4"
   }
 }