identity-admin 1.24.2 → 1.24.4

package/lib/controllers/DashboardController.js

@@ -36,6 +36,7 @@ const FiltersHelper_1 = __importDefault(require("../helpers/FiltersHelper"));
 const LocalizedStringHelper_1 = __importDefault(require("../helpers/LocalizedStringHelper"));
 const ActionsGenerator_1 = __importDefault(require("../helpers/ActionsGenerator"));
 const helpers_1 = require("../types/helpers");
+const PopulationHelper_1 = require("../helpers/PopulationHelper");
 let DashboardController = DashboardController_1 = class DashboardController {
     constructor(resource, repository, resources, modelConfigurations) {
         this.resource = resource;
@@ -157,7 +158,6 @@ let DashboardController = DashboardController_1 = class DashboardController {
             if (sortBy !== "_id") {
                 sortQuery._id = "asc";
             }
-            const populate = req.query.populate;
             var filter = {};
             if (scope &&
                 resource.properties.filters &&
@@ -183,11 +183,14 @@ let DashboardController = DashboardController_1 = class DashboardController {
             }
             var records = [];
             var pageInfo = undefined;
+            const populatedString = modifiedResource.properties.populatedString;
+            const populationHelper = new PopulationHelper_1.PopulationHelper(resource, PopulationHelper_1.PopulationType.LIST, populatedString);
+            const modifiedPopulatedObject = yield populationHelper.get();
             if (!req.query.page && !req.query.perPage) {
                 records = yield repository.findMany({
                     sort: sortQuery,
                     filter,
-                    populate: modifiedResource.properties.populatedString,
+                    populate: modifiedPopulatedObject,
                 });
             }
             else {
@@ -195,7 +198,7 @@ let DashboardController = DashboardController_1 = class DashboardController {
                     sort: sortQuery,
                     filter,
                     paginateParams: paginateParams,
-                    populate: modifiedResource.properties.populatedString,
+                    populate: modifiedPopulatedObject,
                 });
                 records = page.records;
                 pageInfo = page.pageInfo;
@@ -364,11 +367,14 @@ let DashboardController = DashboardController_1 = class DashboardController {
             }
             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 populatedString = modifiedResource.properties.populatedString;
+            const populationHelper = new PopulationHelper_1.PopulationHelper(resource, PopulationHelper_1.PopulationType.SHOW, populatedString);
+            const modifiedPopulatedObject = yield populationHelper.get();
             var record = yield repository.findOne({
                 filter: {
                     _id: recordId,
                 },
-                populate: modifiedResource.properties.populatedString,
+                populate: modifiedPopulatedObject,
             });
             if (!record) {
                 return ResponseUtils_1.default.send(res, 404, "record not found");
@@ -489,11 +495,14 @@ let DashboardController = DashboardController_1 = class DashboardController {
             }
             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 populatedString = modifiedResource.properties.populatedString;
+            const populationHelper = new PopulationHelper_1.PopulationHelper(resource, PopulationHelper_1.PopulationType.SHOW, populatedString);
+            const modifiedPopulatedObject = yield populationHelper.get();
             var record = yield repository.findOne({
                 filter: {
                     _id: recordId,
                 },
-                populate: modifiedResource.properties.populatedString,
+                populate: modifiedPopulatedObject,
             });
             if (!record) {
                 return ResponseUtils_1.default.send(res, 404, "record not found");
@@ -505,18 +514,20 @@ let DashboardController = DashboardController_1 = class DashboardController {
             const sort = modifiedResource.properties.defaultOrder;
             const nextQuery = {};
             const prevQuery = {};
-            const sortQuery = {};
+            const nextSortQuery = {};
+            const previousSortQuery = {};
             const greaterThanQuery = { $gt: record[sortBy] };
             const lessThanQuery = { $lt: record[sortBy] };
             nextQuery[sortBy] = sort === 'asc' ? greaterThanQuery : lessThanQuery;
             prevQuery[sortBy] = sort === 'asc' ? lessThanQuery : greaterThanQuery;
-            sortQuery[sortBy] = sort;
+            nextSortQuery[sortBy] = sort;
+            previousSortQuery[sortBy] = sort === 'asc' ? 'desc' : 'asc';
             var neighbor;
             if (neighborRecordType === helpers_1.NeighborTypes.NEXT) {
-                neighbor = yield (model === null || model === void 0 ? void 0 : model.findOne(nextQuery).sort(sortQuery).limit(1));
+                neighbor = yield (model === null || model === void 0 ? void 0 : model.findOne(nextQuery).sort(nextSortQuery).limit(1));
             }
             else {
-                neighbor = yield (model === null || model === void 0 ? void 0 : model.findOne(prevQuery).sort(sortQuery).limit(1));
+                neighbor = yield (model === null || model === void 0 ? void 0 : model.findOne(prevQuery).sort(previousSortQuery).limit(1));
             }
             const hasNeighbor = record && neighbor && neighbor._id ? true : false;
             const neighborRecordId = hasNeighbor ? neighbor._id : undefined;

package/lib/helpers/PopulationHelper.d.ts

@@ -0,0 +1,12 @@
+import { IResourceFile } from "../types/IResourceFile";
+export declare enum PopulationType {
+    LIST = "LIST",
+    SHOW = "SHOW"
+}
+export declare class PopulationHelper {
+    private resource;
+    private populatedString;
+    private populationType;
+    constructor(resource: IResourceFile, populationType: PopulationType, populatedString: any);
+    get(): Promise<any>;
+}

package/lib/helpers/PopulationHelper.js

@@ -0,0 +1,50 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PopulationHelper = exports.PopulationType = void 0;
+var PopulationType;
+(function (PopulationType) {
+    PopulationType["LIST"] = "LIST";
+    PopulationType["SHOW"] = "SHOW";
+})(PopulationType = exports.PopulationType || (exports.PopulationType = {}));
+class PopulationHelper {
+    constructor(resource, populationType, populatedString) {
+        this.resource = resource;
+        this.populatedString = populatedString;
+        this.populationType = populationType;
+    }
+    get() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { populate } = this.resource.properties;
+            if (!populate) {
+                return this.populatedString;
+            }
+            if (!populate.all && !populate.list && !populate.show) {
+                return this.populatedString;
+            }
+            if (populate.all) {
+                return yield populate.all(this.populatedString);
+            }
+            if (this.populationType === PopulationType.LIST) {
+                if (populate.list) {
+                    return yield populate.list(this.populatedString);
+                }
+            }
+            else {
+                if (populate.show) {
+                    return yield populate.show(this.populatedString);
+                }
+            }
+            return this.populatedString;
+        });
+    }
+}
+exports.PopulationHelper = PopulationHelper;

package/lib/types/IResourceFile.d.ts

@@ -2,12 +2,13 @@ import { Document, Model } from "mongoose";
 import { IRequest } from "../middlewares/isAuth";
 import { IRepository } from "../repositories/Repository";
 import { ActionNames, ActionTypes, FieldTypes, FileTypes, HandlerStrategy, Virtuals } from "./helpers";
-declare type orderTypes = 'asc' | 'desc';
-declare type VirtualFieldTypes = 'password' | 'ref' | 'Array';
-declare type Severity = 'success' | 'info' | 'warning' | 'error';
-declare type ButtonColors = 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
-declare type ButtonVariants = 'text' | 'outlined' | 'contained';
-declare type ButtonSizes = 'small' | 'medium' | 'large';
+declare type orderTypes = "asc" | "desc";
+declare type VirtualFieldTypes = "password" | "ref" | "Array";
+declare type Severity = "success" | "info" | "warning" | "error";
+declare type ButtonColors = "inherit" | "primary" | "secondary" | "success" | "error" | "info" | "warning";
+declare type ButtonVariants = "text" | "outlined" | "contained";
+declare type ButtonSizes = "small" | "medium" | "large";
+declare type PopulateFunction = (populatedString: any) => Promise<any>;
 interface Parent {
     /**
      * Name of the parent
@@ -19,6 +20,20 @@ interface Parent {
      */
     icon: string;
 }
+interface IPopulate {
+    /**
+     * This function is called for all the endpoints to have an access over the populated string
+     */
+    all?: PopulateFunction;
+    /**
+     * This function is called for the list endpoint to have an access over the populated string
+     */
+    list?: PopulateFunction;
+    /**
+     * This function is called for the get one endpoint either in show or form an access over the populated string
+     */
+    show?: PopulateFunction;
+}
 interface Action {
     /**
      * Specify if this action is accessible or not.
@@ -126,9 +141,9 @@ interface IFilters {
      */
     scopes?: {
         /**
-        * Specify if this filter is accessible or not
-        * @default false
-        */
+         * Specify if this filter is accessible or not
+         * @default false
+         */
         isAccessible: boolean;
         /**
          * Automatic scope that filters by the specified key with one of the given options
@@ -147,9 +162,9 @@ interface IFilters {
      */
     searchBar?: {
         /**
-        * Specify if this filter is accessible or not
-        * @default true
-        */
+         * Specify if this filter is accessible or not
+         * @default true
+         */
         isAccessible: boolean;
     };
 }
@@ -230,9 +245,9 @@ export interface IFieldValue {
      */
     withTime?: boolean;
     /**
-    * Specify the api route that to be called for getting the referenced values
-    * @default undefined
-    */
+     * Specify the api route that to be called for getting the referenced values
+     * @default undefined
+     */
     apiRoute?: string;
     /**
      * Path of the value inside the model schema
@@ -337,7 +352,7 @@ interface ExtraAction {
     /**
      * Alert message appear after executing this action.
      * @default 'Action was executed successfully'
-    */
+     */
     message?: string;
     /**
      * The severity of the alert. This defines the color and icon used.
@@ -473,11 +488,15 @@ export interface IResourceFile {
         model?: {
             [key: string]: IFieldValue;
         } | IModel;
+        /**
+         * Override the populated object
+         */
+        populate?: IPopulate;
     };
     /**
-    * Array of properties that should be appeared in the list action.
-    * @default 'The whole fields'
-    */
+     * Array of properties that should be appeared in the list action.
+     * @default 'The whole fields'
+     */
     listProperties?: string[];
     /**
      * Arrays of properties that should be appeared in the show action.

package/package.json

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