identity-admin 1.26.3 → 1.26.5

package/lib/controllers/ActionController.js

@@ -27,6 +27,7 @@ const ResponseUtils_1 = __importDefault(require("../utils/ResponseUtils"));
 const StringUtils_1 = __importDefault(require("../utils/StringUtils"));
 const Repository_1 = __importDefault(require("../repositories/Repository"));
 const ResourceUtils_1 = require("../utils/ResourceUtils");
+const UserActionsLog_1 = __importDefault(require("../models/userActionsLog/UserActionsLog"));
 let ActionController = class ActionController {
     constructor(resources) {
         this.resources = resources;
@@ -57,7 +58,18 @@ let ActionController = class ActionController {
             for (var i = 0; i < extraActions.length; i++) {
                 const extraAction = extraActions[i];
                 if (extraAction.key === actionKey) {
+                    const oldRecord = yield repository.findById(record._id);
                     response = yield extraAction.handler(req, res, data);
+                    const newRecord = yield repository.findById(record._id);
+                    const userActionsLog = new UserActionsLog_1.default({
+                        action: actionKey,
+                        modelName,
+                        userId: req.user._id,
+                        dataBefore: JSON.stringify(oldRecord),
+                        dataAfter: JSON.stringify(newRecord),
+                        resourceId: record._id,
+                    });
+                    yield userActionsLog.save();
                     break;
                 }
             }

package/lib/controllers/DashboardController.js

@@ -38,6 +38,8 @@ 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"));
+const IUserActionsLog_1 = require("../models/userActionsLog/IUserActionsLog");
+const UserActionsLog_1 = __importDefault(require("../models/userActionsLog/UserActionsLog"));
 let DashboardController = DashboardController_1 = class DashboardController {
     constructor(resource, repository, resources, modelConfigurations) {
         this.resource = resource;
@@ -231,7 +233,7 @@ let DashboardController = DashboardController_1 = class DashboardController {
         });
     }
     create(req, res) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.validateRequest(req, res)) {
                 return;
@@ -283,6 +285,17 @@ let DashboardController = DashboardController_1 = class DashboardController {
             if (!record.isValid() || !record.document) {
                 return ResponseUtils_1.default.unprocessable(res, 'Invalid Data', record.getErrors());
             }
+            if ((_e = resource.properties) === null || _e === void 0 ? void 0 : _e.enableLog) {
+                const newRecord = yield repository.findById(record.getDocument()._id);
+                const userActionsLog = new UserActionsLog_1.default({
+                    action: IUserActionsLog_1.UserActions.CREATE,
+                    modelName: (_f = resource === null || resource === void 0 ? void 0 : resource.properties) === null || _f === void 0 ? void 0 : _f.modelName,
+                    userId: req.user._id,
+                    dataAfter: JSON.stringify(newRecord),
+                    resourceId: newRecord === null || newRecord === void 0 ? void 0 : newRecord._id,
+                });
+                yield userActionsLog.save();
+            }
             if (crudOperations && crudOperations.create && crudOperations.create.after) {
                 record = yield crudOperations.create.after(req, record, currentUser, recordParams);
             }
@@ -292,7 +305,7 @@ let DashboardController = DashboardController_1 = class DashboardController {
         });
     }
     update(req, res) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f, _g;
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.validateRequest(req, res)) {
                 return;
@@ -348,6 +361,18 @@ let DashboardController = DashboardController_1 = class DashboardController {
             // if (resource.properties.modelName === ModelNames.Settings) {
             //     await AppSettings.run()
             // }
+            if ((_f = resource.properties) === null || _f === void 0 ? void 0 : _f.enableLog) {
+                const newRecord = yield repository.findById(record._id);
+                const userActionsLog = new UserActionsLog_1.default({
+                    action: IUserActionsLog_1.UserActions.EDIT,
+                    modelName: (_g = resource === null || resource === void 0 ? void 0 : resource.properties) === null || _g === void 0 ? void 0 : _g.modelName,
+                    userId: req.user._id,
+                    dataBefore: JSON.stringify(record),
+                    dataAfter: JSON.stringify(newRecord),
+                    resourceId: record._id,
+                });
+                yield userActionsLog.save();
+            }
             if (crudOperations && crudOperations.update && crudOperations.update.after) {
                 recordSaveResult = yield crudOperations.update.after(req, recordSaveResult, recordParams, currentUser);
             }
@@ -534,7 +559,7 @@ let DashboardController = DashboardController_1 = class DashboardController {
         });
     }
     delete(req, res) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.validateRequest(req, res)) {
                 return;
@@ -563,6 +588,16 @@ let DashboardController = DashboardController_1 = class DashboardController {
             if (!record) {
                 return ResponseUtils_1.default.send(res, 404, 'record Not Found');
             }
+            if ((_e = resource.properties) === null || _e === void 0 ? void 0 : _e.enableLog) {
+                const userActionsLog = new UserActionsLog_1.default({
+                    action: IUserActionsLog_1.UserActions.DELETE,
+                    modelName: (_f = resource === null || resource === void 0 ? void 0 : resource.properties) === null || _f === void 0 ? void 0 : _f.modelName,
+                    userId: req.user._id,
+                    dataBefore: JSON.stringify(record),
+                    resourceId: record._id,
+                });
+                yield userActionsLog.save();
+            }
             yield repository.remove({ _id: record._id });
             return ResponseUtils_1.default.send(res, 200, 'OK');
         });

package/lib/helpers/ResourceGenerator.js

@@ -38,7 +38,7 @@ const SetupParent = {
 };
 class ResourceGenerator {
     static generate(resource, currentUser, configurations, modelConfigurations, permissions) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         const SetupParent = {
             name: "Setup",
             icon: "PermDataSetting",
@@ -161,7 +161,7 @@ class ResourceGenerator {
                 ? (_d = (_c = resource.properties.filters) === null || _c === void 0 ? void 0 : _c.scopes) === null || _d === void 0 ? void 0 : _d.auto.options
                 : (_g = (_f = (_e = resource.properties.filters) === null || _e === void 0 ? void 0 : _e.scopes) === null || _f === void 0 ? void 0 : _f.manual) === null || _g === void 0 ? void 0 : _g.options;
             modifiedResource.properties.filters.scopes.options =
-                ResourceHelper_1.default.setScopeFilterOptions(modelName, options);
+                ResourceHelper_1.default.setScopeFilterOptions(modelName, options, ((_j = (_h = resource.properties.filters) === null || _h === void 0 ? void 0 : _h.scopes) === null || _j === void 0 ? void 0 : _j.showAll) === undefined ? true : (_l = (_k = resource.properties.filters) === null || _k === void 0 ? void 0 : _k.scopes) === null || _l === void 0 ? void 0 : _l.showAll);
         }
         const actions = ActionsGenerator_1.default.generateActions(actionsCheck, resource, currentUser, modelConfiguration);
         modifiedResource.properties.actions = actions;

package/lib/helpers/ResourceHelper.d.ts

@@ -9,7 +9,7 @@ export default class ResourcesHelper {
     static prepareFilterProperties(properties: string[], schema: any): string[];
     static checkResourceTranslation(resource: IResourceFile, key: string): string | undefined;
     static checkActionTranslation(resource: IResourceFile, action: string): string | undefined;
-    static setScopeFilterOptions(modelName: string, options: string[]): any;
+    static setScopeFilterOptions(modelName: string, options: string[], showAll: boolean): any;
     static getFilters(filters: any): {
         scopes: {};
         searchBar: {};

package/lib/helpers/ResourceHelper.js

@@ -151,12 +151,14 @@ class ResourcesHelper {
         translation = (0, i18n_1.__)({ phrase: resource.properties.actionsTranslations[action], locale: i18n_1.default.getLocale() });
         return translation;
     }
-    static setScopeFilterOptions(modelName, options) {
+    static setScopeFilterOptions(modelName, options, showAll) {
         var arrayOfOptions = [];
-        arrayOfOptions.push({
-            key: 'all',
-            value: (0, i18n_1.__)({ phrase: 'ALL', locale: i18n_1.default.getLocale() }),
-        });
+        if (showAll) {
+            arrayOfOptions.push({
+                key: 'all',
+                value: (0, i18n_1.__)({ phrase: 'ALL', locale: i18n_1.default.getLocale() }),
+            });
+        }
         options.forEach((key) => {
             const optionObject = {
                 key,

package/lib/helpers/UserActionsLog/UserActionsLogHelper.d.ts

@@ -0,0 +1,2 @@
+export declare function renderDiff(diff: any): string | null;
+export declare function isRelevant(diff: any): boolean;

package/lib/helpers/UserActionsLog/UserActionsLogHelper.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRelevant = exports.renderDiff = void 0;
+function renderDiff(diff) {
+    var _a;
+    const path = (_a = diff.path) === null || _a === void 0 ? void 0 : _a.join('.');
+    const oldValue = formatValue(diff.lhs);
+    const newValue = formatValue(diff.rhs);
+    switch (diff.kind) {
+        case 'N':
+            return `${path}: Added - ${newValue}`;
+        case 'D':
+            return `${path}: Removed - ${oldValue}`;
+        case 'E':
+            return `${path}: Modified - ${oldValue} => ${newValue}`;
+        case 'A':
+            return renderArrayChange(diff, path);
+        default:
+            return null;
+    }
+}
+exports.renderDiff = renderDiff;
+function formatValue(value) {
+    if (typeof value === 'object') {
+        return JSON.stringify(value);
+    }
+    if (typeof value === 'boolean') {
+        return `${value}`;
+    }
+    return value;
+}
+function renderArrayChange(diff, path) {
+    const { index, item } = diff;
+    const { kind, rhs, lhs } = item;
+    const changeText = kind === 'N' ? 'Added' : 'Removed';
+    const value = formatValue(kind === 'N' ? rhs : lhs);
+    if (typeof index !== 'undefined') {
+        return `${path}[${index}]: ${changeText} - ${value}`;
+    }
+    else {
+        return `${path}: Array Change - ${changeText} ${value}`;
+    }
+}
+function isRelevant(diff) {
+    var _a;
+    const lastElement = (_a = diff.path) === null || _a === void 0 ? void 0 : _a.slice(-1)[0];
+    return !['__v', 'createdAt', 'updatedAt', '_id', 'id'].includes(lastElement);
+}
+exports.isRelevant = isRelevant;

package/lib/models/ModelNames.d.ts

@@ -4,4 +4,5 @@ export default class ModelNames {
     static Permission: string;
     static PermissionGroup: string;
     static AdminPermission: string;
+    static UserActionsLog: string;
 }

package/lib/models/ModelNames.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 class ModelNames {
 }
 exports.default = ModelNames;
-ModelNames.User = 'IdentityUser';
+ModelNames.User = 'User';
 ModelNames.RequestLog = 'RequestLog';
 ModelNames.Permission = 'Permission';
 ModelNames.PermissionGroup = 'PermissionGroup';
 ModelNames.AdminPermission = 'AdminPermission';
+ModelNames.UserActionsLog = 'UserActionsLog';

package/lib/models/userActionsLog/IUserActionsLog.d.ts

@@ -0,0 +1,24 @@
+import { Document, Model, Types } from 'mongoose';
+export declare enum UserActions {
+    CREATE = "create",
+    EDIT = "edit",
+    DELETE = "delete"
+}
+export interface IUserActionsLogProps {
+    _id?: Types.ObjectId;
+    userId: Types.ObjectId;
+    action: string;
+    modelName: string;
+    dataBefore?: string;
+    dataAfter?: string;
+    resourceId?: Types.ObjectId;
+    changes?: string;
+    user?: any;
+}
+export interface IUserActionsLogDocument extends IUserActionsLogProps, Document {
+    _id: Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export default interface IUserActionsLogModel extends Model<IUserActionsLogDocument> {
+}

package/lib/models/userActionsLog/IUserActionsLog.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserActions = void 0;
+var UserActions;
+(function (UserActions) {
+    UserActions["CREATE"] = "create";
+    UserActions["EDIT"] = "edit";
+    UserActions["DELETE"] = "delete";
+})(UserActions = exports.UserActions || (exports.UserActions = {}));

package/lib/models/userActionsLog/UserActionsLog.d.ts

@@ -0,0 +1,3 @@
+import IUserActionsLogModel from "./IUserActionsLog";
+declare const UserActionsLog: IUserActionsLogModel;
+export default UserActionsLog;

package/lib/models/userActionsLog/UserActionsLog.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongoose_1 = require("mongoose");
+const ModelNames_1 = __importDefault(require("../ModelNames"));
+const deep_diff_1 = require("deep-diff");
+const UserActionsLogHelper_1 = require("../../helpers/UserActionsLog/UserActionsLogHelper");
+const UserActionsLogSchema = new mongoose_1.Schema({
+    userId: {
+        type: mongoose_1.Schema.Types.ObjectId,
+        required: true,
+    },
+    action: {
+        type: String,
+        required: true,
+    },
+    modelName: {
+        type: String,
+        required: true,
+    },
+    dataBefore: {
+        type: String,
+    },
+    dataAfter: {
+        type: String,
+    },
+    resourceId: {
+        type: mongoose_1.Schema.Types.ObjectId,
+        refPath: 'modelName'
+    }
+}, { timestamps: true, toJSON: { virtuals: true }, toObject: { virtuals: true } });
+UserActionsLogSchema.virtual('changes').get(function () {
+    const deepDiff_changes = (0, deep_diff_1.diff)(this.dataBefore ? JSON.parse(this.dataBefore) : undefined, this.dataAfter ? JSON.parse(this.dataAfter) : undefined);
+    let changes = '';
+    deepDiff_changes === null || deepDiff_changes === void 0 ? void 0 : deepDiff_changes.forEach((diff) => (changes += (0, UserActionsLogHelper_1.isRelevant)(diff) ? `${(0, UserActionsLogHelper_1.renderDiff)(diff)}\n` : ''));
+    return changes;
+});
+const UserActionsLog = (0, mongoose_1.model)(ModelNames_1.default.UserActionsLog, UserActionsLogSchema);
+exports.default = UserActionsLog;

package/lib/types/IResourceFile.d.ts

@@ -3,7 +3,7 @@ import { Document, Model } from 'mongoose';
 import { IRequest } from '../middlewares/isAuth';
 import { IRepository, PageInfo, PaginateParams } from '../repositories/Repository';
 import SaveResult from '../repositories/SaveResult';
-import { ActionNames, ActionTypes, FieldTypes, FileTypes, HandlerStrategy, NeighborTypes, Virtuals } from './helpers';
+import { ActionNames, ActionTypes, FieldTypes, FileTypes, HandlerStrategy, ImageOptimizingCategories, NeighborTypes, Virtuals } from './helpers';
 declare type orderTypes = 'asc' | 'desc';
 declare type VirtualFieldTypes = 'password' | 'ref' | 'Array';
 declare type Severity = 'success' | 'info' | 'warning' | 'error';
@@ -186,6 +186,11 @@ interface IFilters {
          * @default false
          */
         isAccessible: boolean;
+        /**
+         * Show All tab
+         * @default true
+         */
+        showAll?: boolean;
         /**
          * Automatic scope that filters by the specified key with one of the given options
          * This filter works automatically by mentioning the key as saved in the database along with the values that this key can has.
@@ -282,6 +287,11 @@ export interface IFieldValue {
      * Can be used only if this field is a reference to the Image collection
      */
     mediaUploader?: boolean;
+    /**
+     * Used only if this field is of type image. It specifies what is the optimizing level of an image before upload
+     * @default NORMAL
+     */
+    imageOptimizingCategory?: ImageOptimizingCategories;
     /**
      * Specify the type of the file to be uploaded. Only required if the media uploader is true.
      * @default image
@@ -517,6 +527,11 @@ export interface IResourceFile {
          * @default true
          */
         isVisible?: (currentUser: Document) => Promise<boolean>;
+        /**
+         * The property that controls the ability of logging changes of this resource.
+         * @default false
+         */
+        enableLog?: (currentUser: Document) => Promise<boolean>;
         /**
          * The default order
          * @default asc

package/lib/types/helpers.d.ts

@@ -59,3 +59,7 @@ export declare enum NeighborTypes {
     NEXT = "NEXT",
     PREVIOUS = "PREVIOUS"
 }
+export declare enum ImageOptimizingCategories {
+    NORMAL = "NORMAL",
+    BANNERS = "BANNERS"
+}

package/lib/types/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NeighborTypes = exports.HandlerStrategy = exports.FileTypes = exports.FieldTypes = exports.ActionTypes = exports.ActionNames = exports.Virtuals = void 0;
+exports.ImageOptimizingCategories = exports.NeighborTypes = exports.HandlerStrategy = exports.FileTypes = exports.FieldTypes = exports.ActionTypes = exports.ActionNames = exports.Virtuals = void 0;
 var Virtuals;
 (function (Virtuals) {
     Virtuals["SHOW"] = "SHOW";
@@ -69,3 +69,8 @@ var NeighborTypes;
     NeighborTypes["NEXT"] = "NEXT";
     NeighborTypes["PREVIOUS"] = "PREVIOUS";
 })(NeighborTypes = exports.NeighborTypes || (exports.NeighborTypes = {}));
+var ImageOptimizingCategories;
+(function (ImageOptimizingCategories) {
+    ImageOptimizingCategories["NORMAL"] = "NORMAL";
+    ImageOptimizingCategories["BANNERS"] = "BANNERS";
+})(ImageOptimizingCategories = exports.ImageOptimizingCategories || (exports.ImageOptimizingCategories = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "identity-admin",
-  "version": "1.26.3",
+  "version": "1.26.5",
   "description": "",
   "main": "lib/Dashboard.js",
   "types": "lib/Dashbord.d.ts",
@@ -42,10 +42,12 @@
   },
   "dependencies": {
     "@react-pdf/renderer": "^3.1.14",
+    "@types/deep-diff": "^1.0.5",
     "@types/express-session": "^1.17.5",
     "bcryptjs": "^2.4.3",
     "connect-mongo": "^4.6.0",
     "cookie-parser": "^1.4.6",
+    "deep-diff": "^1.0.2",
     "express-session": "^1.17.3",
     "lodash": "^4.17.21",
     "memory-cache": "^0.2.0",