identity-admin 1.6.0 → 1.8.0

package/lib/controllers/DashboardController.d.ts

@@ -32,5 +32,6 @@ export default class DashboardController {
     create(req: IRequest, res: Response): Promise<void>;
     update(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

@@ -34,6 +34,7 @@ const inversify_1 = require("inversify");
 const Repository_1 = __importDefault(require("../repositories/Repository"));
 const ResourceUtils_1 = require("../utils/ResourceUtils");
 const FiltersHelper_1 = __importDefault(require("../helpers/FiltersHelper"));
+const LocalizedStringHelper_1 = __importDefault(require("../helpers/LocalizedStringHelper"));
 let DashboardController = DashboardController_1 = class DashboardController {
     constructor(resource, repository, resources) {
         this.resource = resource;
@@ -66,7 +67,15 @@ let DashboardController = DashboardController_1 = class DashboardController {
             filter[searchBy] = subString.source;
             return filter;
         }
-        filter[searchBy] = subString;
+        if (LocalizedStringHelper_1.default.checkLocalizedStringType(resource, searchBy)) {
+            filter.$or = [
+                LocalizedStringHelper_1.default.getFilterObject(searchBy, "0", subString),
+                LocalizedStringHelper_1.default.getFilterObject(searchBy, "1", subString),
+            ];
+        }
+        else {
+            filter[searchBy] = subString;
+        }
         return filter;
     }
     getScopeFilter(filter, scope) {
@@ -129,10 +138,6 @@ let DashboardController = DashboardController_1 = class DashboardController {
             }
             const populate = req.query.populate;
             var filter = {};
-            const crudOperations = resource.properties.crudOperations;
-            if (crudOperations && crudOperations.index) {
-                filter = crudOperations.index.before(filter, currentUser);
-            }
             if (scope && resource.properties.filters && resource.properties.filters.scopes && resource.properties.filters.scopes.isAccessible) {
                 if (resource.properties.filters.scopes.manual) {
                     filter = resource.properties.filters.scopes.manual.handler(filter, scope);
@@ -148,6 +153,10 @@ let DashboardController = DashboardController_1 = class DashboardController {
                 filter = this.getSearchableSubStringFilter(resource, filter, searchableSubString);
             }
             filter = FiltersHelper_1.default.appendFilters(filter, filters);
+            const crudOperations = resource.properties.crudOperations;
+            if (crudOperations && crudOperations.index) {
+                filter = crudOperations.index.before(req, filter, currentUser);
+            }
             var records = [];
             var pageInfo = undefined;
             if (!req.query.page && !req.query.perPage) {
@@ -202,9 +211,10 @@ let DashboardController = DashboardController_1 = class DashboardController {
             const modifiedResource = ResourceGenerator_1.default.generate(resource);
             var recordParams = req.body;
             const currentUser = req.user;
+            recordParams = LocalizedStringHelper_1.default.mapLocalizableString(recordParams, resource);
             const crudOperations = resource.properties.crudOperations;
             if (crudOperations && crudOperations.create) {
-                recordParams = crudOperations.create.before(recordParams, currentUser);
+                recordParams = crudOperations.create.before(req, recordParams, currentUser);
             }
             var record;
             if (recordParams.password) {
@@ -241,6 +251,7 @@ let DashboardController = DashboardController_1 = class DashboardController {
             if (!record) {
                 return ResponseUtils_1.default.send(res, 404, 'record Not Found');
             }
+            recordParams = LocalizedStringHelper_1.default.mapLocalizableString(recordParams, resource);
             const recordSaveResult = yield repository.update(record, recordParams);
             if (!recordSaveResult.isValid()) {
                 return ResponseUtils_1.default.unprocessable(res, 'Invalid Data', recordSaveResult.getErrors());
@@ -282,11 +293,35 @@ let DashboardController = DashboardController_1 = class DashboardController {
             const afterMethod = (_e = (_d = resource.properties.crudOperations) === null || _d === void 0 ? void 0 : _d.show) === null || _e === void 0 ? void 0 : _e.after;
             let extras = {};
             if (afterMethod && record) {
-                extras = yield afterMethod(record);
+                extras = yield afterMethod(req, record);
             }
             return ResponseUtils_1.default.ok(res, Object.assign(Object.assign({}, extras), { record: record ? record : null }));
         });
     }
+    deleteAll(req, res) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.validateRequest(req, res)) {
+                return;
+            }
+            const modelName = req.params.resource;
+            const recordIds = req.body;
+            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', []);
+            }
+            const repository = (_c = this.repository) !== null && _c !== void 0 ? _c : new Repository_1.default(resource.properties.resource);
+            for (var i = 0; i < recordIds.length; i++) {
+                const recordId = recordIds[i];
+                const record = yield repository.findById(recordId);
+                if (!record) {
+                    continue;
+                }
+                yield repository.remove({ _id: record._id });
+            }
+            return ResponseUtils_1.default.send(res, 200, 'OK');
+        });
+    }
     delete(req, res) {
         var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
@@ -335,6 +370,11 @@ __decorate([
     __param(0, (0, inversify_express_utils_1.request)()),
     __param(1, (0, inversify_express_utils_1.response)())
 ], DashboardController.prototype, "show", null);
+__decorate([
+    (0, inversify_express_utils_1.httpDelete)('/all'),
+    __param(0, (0, inversify_express_utils_1.request)()),
+    __param(1, (0, inversify_express_utils_1.response)())
+], DashboardController.prototype, "deleteAll", null);
 __decorate([
     (0, inversify_express_utils_1.httpDelete)('/:id'),
     __param(0, (0, inversify_express_utils_1.request)()),

package/lib/helpers/FiltersHelper.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const mongoose_1 = __importDefault(require("mongoose"));
 const helpers_1 = require("../types/helpers");
+const LocalizedStringHelper_1 = __importDefault(require("./LocalizedStringHelper"));
 var pluralize = require('pluralize');
 class FilterHelper {
     static appendFilters(filterQuery, filters) {
@@ -52,6 +53,12 @@ class FilterHelper {
                 case helpers_1.FieldTypes.STRING:
                     filterQuery[key] = new RegExp(value, 'i');
                     break;
+                case helpers_1.FieldTypes.LOCALIZEDSTRING:
+                    filterQuery.$or = [
+                        LocalizedStringHelper_1.default.getFilterObject(key, "0", new RegExp(value, 'i')),
+                        LocalizedStringHelper_1.default.getFilterObject(key, "1", new RegExp(value, 'i')),
+                    ];
+                    break;
                 default:
                     if (value !== 'null' && value !== 'undefined') {
                         filterQuery[key] = value;

package/lib/helpers/LocalizedStringHelper.d.ts

@@ -0,0 +1,9 @@
+import { IResourceFile } from "../types/IResourceFile";
+export default class LocalizedStringHelper {
+    static mapLocalizableString(recordParams: any, resource: IResourceFile): any;
+    private static getArrayOfLanguages;
+    static checkLocalizedStringType(resource: IResourceFile, fieldName: string): boolean;
+    static getFilterObject(searchBy: string, index: string, value: any): {
+        [key: string]: any;
+    };
+}

package/lib/helpers/LocalizedStringHelper.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("../types/helpers");
+class LocalizedStringHelper {
+    static mapLocalizableString(recordParams, resource) {
+        const modelObject = resource.properties.model;
+        if (!modelObject) {
+            return recordParams;
+        }
+        for (const key in modelObject) {
+            if (!modelObject.hasOwnProperty(key) || key === 'virtuals') {
+                continue;
+            }
+            const castedModelObject = modelObject;
+            if (castedModelObject[key].type && castedModelObject[key].type === helpers_1.FieldTypes.LOCALIZEDSTRING && recordParams[key]) {
+                recordParams[key] = this.getArrayOfLanguages(recordParams[key]);
+            }
+            else if (castedModelObject[key].arrayType && castedModelObject[key].arrayType === helpers_1.FieldTypes.LOCALIZEDSTRING && recordParams[key] && recordParams[key].length !== 0) {
+                for (var j = 0; j < recordParams[key].length; j++) {
+                    recordParams[key][j] = this.getArrayOfLanguages(recordParams[key][j]);
+                }
+            }
+        }
+        return recordParams;
+    }
+    static getArrayOfLanguages(record) {
+        var localizedArray = [];
+        for (const language in record) {
+            if (!record.hasOwnProperty(language)) {
+                continue;
+            }
+            const languageObject = {
+                key: language,
+                value: record[language] ? record[language] : undefined
+            };
+            localizedArray.push(languageObject);
+        }
+        return localizedArray;
+    }
+    static checkLocalizedStringType(resource, fieldName) {
+        const modelObject = resource.properties.model;
+        if (!modelObject || !modelObject.hasOwnProperty(fieldName)) {
+            return false;
+        }
+        const castedModelObject = modelObject;
+        if (castedModelObject[fieldName].type && castedModelObject[fieldName].type === helpers_1.FieldTypes.LOCALIZEDSTRING) {
+            return true;
+        }
+        return false;
+    }
+    static getFilterObject(searchBy, index, value) {
+        const filterObject = {};
+        filterObject[`${searchBy}.${index}.value`] = value;
+        return filterObject;
+    }
+}
+exports.default = LocalizedStringHelper;

package/lib/helpers/SchemaGenerator.js

@@ -48,7 +48,7 @@ class SchemaGenerator {
                     model[field].arrayType = helpers_1.FieldTypes.REFERENCE;
                 }
                 else {
-                    model[field].arrayType = schema[field].caster.instance;
+                    model[field].arrayType = model[field].arrayType ? model[field].arrayType : schema[field].caster.instance;
                 }
             }
             model[field].type = model[field].type ? model[field].type : fieldType;

package/lib/types/IResourceFile.d.ts

@@ -1,15 +1,28 @@
 import { Request } from "express";
 import { Document, Model } from "mongoose";
-import { ActionTypes, Virtuals } from "./helpers";
+import { IRequest } from "../middlewares/isAuth";
+import { ActionTypes, FieldTypes, Virtuals } from "./helpers";
 declare type orderTypes = 'asc' | 'desc';
 declare type VirtualFieldTypes = 'password' | 'ref' | 'Array';
 declare type Severity = 'success' | 'info' | 'warning' | 'error';
 interface IAutoScope {
+    /**
+    * Key of property as specified in the database
+    */
     key: string;
+    /**
+    * Array of values that this key can have
+    */
     options: string[];
 }
 interface IManualScope {
+    /**
+    * Array of values that will be appeared in the scope
+    */
     options: string[];
+    /**
+    * A handler that will be called when scope filter is used. This handler should perform a switch case on the specified options values, each case set the filter on its way.
+    */
     handler: (filter: {
         [key: string]: any;
     }, scope: string) => {
@@ -17,25 +30,42 @@ interface IManualScope {
     };
 }
 interface Parent {
+    /**
+    * Name of the parent
+    */
     name: string;
+    /**
+    * Icon of the parent. You can get the icons from
+    * @link https://mui.com/material-ui/material-icons/
+    */
     icon: string;
 }
 interface Action {
+    /**
+    * Specify if this action is accessible or not.
+    * @default True is the default for show, edit, delete, and new while false for bulk delete. You can ovveride any of these values here.
+    */
     isAccessible?: boolean;
 }
 interface ICrudOperations {
     index?: {
-        before: (filter: {
+        /**
+        * Before handler that gives you the access to the filter object. You can add to the filter object any key and value that will be used in the filter query before getting the records for list. You should return the filter object
+        */
+        before: (req: IRequest, filter: {
             [key: string]: any;
         }, currentUser: Document) => {
             [key: string]: any;
         };
     };
     create?: {
-        before: (params: any, currentUser: Document) => any;
+        /**
+        * Before handler that is called before creating a new record. This function gives you the access to the record params before saving it, you can perform any update to the params before saving it. This function should return the params
+        */
+        before: (req: IRequest, params: any, currentUser: Document) => any;
     };
     show?: {
-        after: (record: Document) => Promise<{
+        after: (req: IRequest, record: Document) => Promise<{
             record: Document;
             [key: string]: any;
         }>;
@@ -64,6 +94,13 @@ export interface IFieldValue {
     required?: boolean;
     isEditable?: boolean;
     type?: string;
+    /**
+    * Specify the allowed country codes. Only mandatory if the type is phone number
+    * Alert message appear after executing this action.
+    * ex: ["sa", "eg", ...]
+    */
+    countryCodes?: string[];
+    arrayType?: FieldTypes;
     mediaUploader?: boolean;
 }
 export interface IVirtualValue {

package/lib/types/helpers.d.ts

@@ -24,5 +24,9 @@ export declare enum FieldTypes {
     OBJECTID = "ObjectID",
     NESTEDSCHEMA = "nestedSchema",
     ARRAY = "Array",
-    IMAGE = "image"
+    IMAGE = "image",
+    LOCALIZEDSTRING = "localizedString",
+    PHONENUMBER = "phoneNumber",
+    COLOR = "color",
+    TIMEPICKER = "timePicker"
 }

package/lib/types/helpers.js

@@ -32,4 +32,8 @@ var FieldTypes;
     FieldTypes["NESTEDSCHEMA"] = "nestedSchema";
     FieldTypes["ARRAY"] = "Array";
     FieldTypes["IMAGE"] = "image";
+    FieldTypes["LOCALIZEDSTRING"] = "localizedString";
+    FieldTypes["PHONENUMBER"] = "phoneNumber";
+    FieldTypes["COLOR"] = "color";
+    FieldTypes["TIMEPICKER"] = "timePicker";
 })(FieldTypes = exports.FieldTypes || (exports.FieldTypes = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "identity-admin",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "",
   "main": "lib/Dashboard.js",
   "types": "lib/Dashbord.d.ts",