identity-admin 1.5.0 → 1.7.0

package/lib/types/IResourceFile.d.ts

@@ -1,131 +1,182 @@
-import { Request } from "express";
-import { Document, Model } from "mongoose";
-import { ActionTypes, Virtuals } from "./helpers";
-declare type orderTypes = 'asc' | 'desc';
-declare type VirtualFieldTypes = 'password' | 'ref' | 'Array';
-declare type Severity = 'success' | 'info' | 'warning' | 'error';
-interface Parent {
-    name: string;
-    icon: string;
-}
-interface Action {
-    isAccessible?: boolean;
-}
-interface ICrudOperations {
-    index?: {
-        before: (filter: {
-            [key: string]: any;
-        }, currentUser: Document) => {
-            [key: string]: any;
-        };
-    };
-    create?: {
-        before: (params: any, currentUser: Document) => any;
-    };
-    show?: {
-        after: (record: Document) => Promise<{
-            record: Document;
-            [key: string]: any;
-        }>;
-    };
-}
-export interface ActionData {
-    record: any;
-    currentUser: Document;
-    resource: {
-        name: string;
-        path: string;
-        repository: any;
-    };
-}
-interface IFilters {
-    scopes?: {
-        isAccessible: boolean;
-        key?: string;
-        options?: string[];
-    };
-    searchBar?: {
-        isAccessible: boolean;
-    };
-}
-interface IFieldValue {
-    required?: boolean;
-    isEditable?: boolean;
-    type?: string;
-}
-export interface IVirtualValue {
-    type: VirtualFieldTypes;
-    arrayType?: string;
-    showIn: Virtuals;
-    required: boolean;
-    resource?: Model<any, any>;
-}
-interface IModel {
-    virtuals?: {
-        [key: string]: IVirtualValue;
-    };
-}
-interface ActionOptions {
-    show?: Action;
-    new?: Action;
-    edit?: Action;
-    delete?: Action;
-    bulkDelete?: Action;
-    extras?: ExtraAction[];
-}
-interface ExtraAction {
-    key: string;
-    name: string;
-    /**
-    * Icon of this action.
-    * @reference 'https://mui.com/material-ui/material-icons/'
-    */
-    icon: string;
-    actionType: ActionTypes;
-    /**
-    * Guard message that appears before executing the action to confirm execution.
-    * @default 'No guard message'
-    */
-    guard?: string;
-    /**
-    * 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.
-   * @default 'success'
-   */
-    severity?: Severity;
-    isVisible?: (data: ActionData) => boolean;
-    handler: (req: Request, res: any, data: ActionData) => Promise<any>;
-}
-export interface IResourceFile {
-    properties: {
-        resource: Model<any, any>;
-        modelName: string;
-        name?: string;
-        title?: string;
-        defaultOrderBy?: string;
-        defaultrowsPerPage?: number;
-        defaultOrder?: orderTypes;
-        parent?: Parent;
-        hiddenProperties?: string[];
-        actions?: ActionOptions;
-        filters?: IFilters;
-        crudOperations?: ICrudOperations;
-        keysTranslations?: {
-            [key: string]: any;
-        };
-        actionsTranslations?: {
-            [key: string]: any;
-        };
-        model?: {
-            [key: string]: IFieldValue;
-        } | IModel;
-    };
-    listProperties?: string[];
-    showProperties?: string[];
-    formProperties?: string[];
-}
-export {};
+import { Request } from "express";
+import { Document, Model } from "mongoose";
+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) => {
+        [key: string]: any;
+    };
+}
+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 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 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: (req: IRequest, record: Document) => Promise<{
+            record: Document;
+            [key: string]: any;
+        }>;
+    };
+}
+export interface ActionData {
+    record: any;
+    currentUser: Document;
+    resource: {
+        name: string;
+        path: string;
+        repository: any;
+    };
+}
+interface IFilters {
+    scopes?: {
+        isAccessible: boolean;
+        auto?: IAutoScope;
+        manual?: IManualScope;
+    };
+    searchBar?: {
+        isAccessible: boolean;
+    };
+}
+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 {
+    type: VirtualFieldTypes;
+    arrayType?: string;
+    showIn: Virtuals;
+    required: boolean;
+    resource?: Model<any, any>;
+}
+interface IModel {
+    virtuals?: {
+        [key: string]: IVirtualValue;
+    };
+}
+interface ActionOptions {
+    show?: Action;
+    new?: Action;
+    edit?: Action;
+    delete?: Action;
+    bulkDelete?: Action;
+    extras?: ExtraAction[];
+}
+interface ExtraAction {
+    key: string;
+    name: string;
+    /**
+    * Icon of this action.
+    * @reference 'https://mui.com/material-ui/material-icons/'
+    */
+    icon: string;
+    actionType: ActionTypes;
+    /**
+    * Guard message that appears before executing the action to confirm execution.
+    * @default 'No guard message'
+    */
+    guard?: string;
+    /**
+    * 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.
+   * @default 'success'
+   */
+    severity?: Severity;
+    isVisible?: (data: ActionData) => boolean;
+    handler: (req: Request, res: any, data: ActionData) => Promise<any>;
+}
+export interface IResourceFile {
+    properties: {
+        resource: Model<any, any>;
+        modelName: string;
+        name?: string;
+        title?: string;
+        defaultOrderBy?: string;
+        defaultrowsPerPage?: number;
+        defaultOrder?: orderTypes;
+        parent?: Parent;
+        hiddenProperties?: string[];
+        actions?: ActionOptions;
+        filters?: IFilters;
+        crudOperations?: ICrudOperations;
+        keysTranslations?: {
+            [key: string]: any;
+        };
+        actionsTranslations?: {
+            [key: string]: any;
+        };
+        model?: {
+            [key: string]: IFieldValue;
+        } | IModel;
+    };
+    listProperties?: string[];
+    showProperties?: string[];
+    formProperties?: string[];
+    filterProperties?: string[];
+}
+export {};

package/lib/types/IResourceFile.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/helpers.d.ts

@@ -1,15 +1,32 @@
-export declare enum Virtuals {
-    SHOW = "SHOW",
-    LIST = "LIST",
-    FORM = "FORM"
-}
-export declare enum ActionNames {
-    SHOW = "SHOW",
-    LIST = "LIST",
-    NEW = "NEW",
-    EDIT = "EDIT"
-}
-export declare enum ActionTypes {
-    RECORD = "record",
-    Resource = "resource"
-}
+export declare enum Virtuals {
+    SHOW = "SHOW",
+    LIST = "LIST",
+    FORM = "FORM"
+}
+export declare enum ActionNames {
+    SHOW = "SHOW",
+    LIST = "LIST",
+    NEW = "NEW",
+    EDIT = "EDIT"
+}
+export declare enum ActionTypes {
+    RECORD = "record",
+    Resource = "resource"
+}
+export declare enum FieldTypes {
+    STRING = "String",
+    NUMBER = "Number",
+    ENUM = "enum",
+    REFERENCE = "ref",
+    DATE = "Date",
+    PASSWORD = "password",
+    BOOLEAN = "Boolean",
+    OBJECTID = "ObjectID",
+    NESTEDSCHEMA = "nestedSchema",
+    ARRAY = "Array",
+    IMAGE = "image",
+    LOCALIZEDSTRING = "localizedString",
+    PHONENUMBER = "phoneNumber",
+    COLOR = "color",
+    TIMEPICKER = "timePicker"
+}

package/lib/types/helpers.js

@@ -1,21 +1,39 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionTypes = exports.ActionNames = exports.Virtuals = void 0;
-var Virtuals;
-(function (Virtuals) {
-    Virtuals["SHOW"] = "SHOW";
-    Virtuals["LIST"] = "LIST";
-    Virtuals["FORM"] = "FORM";
-})(Virtuals = exports.Virtuals || (exports.Virtuals = {}));
-var ActionNames;
-(function (ActionNames) {
-    ActionNames["SHOW"] = "SHOW";
-    ActionNames["LIST"] = "LIST";
-    ActionNames["NEW"] = "NEW";
-    ActionNames["EDIT"] = "EDIT";
-})(ActionNames = exports.ActionNames || (exports.ActionNames = {}));
-var ActionTypes;
-(function (ActionTypes) {
-    ActionTypes["RECORD"] = "record";
-    ActionTypes["Resource"] = "resource";
-})(ActionTypes = exports.ActionTypes || (exports.ActionTypes = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldTypes = exports.ActionTypes = exports.ActionNames = exports.Virtuals = void 0;
+var Virtuals;
+(function (Virtuals) {
+    Virtuals["SHOW"] = "SHOW";
+    Virtuals["LIST"] = "LIST";
+    Virtuals["FORM"] = "FORM";
+})(Virtuals = exports.Virtuals || (exports.Virtuals = {}));
+var ActionNames;
+(function (ActionNames) {
+    ActionNames["SHOW"] = "SHOW";
+    ActionNames["LIST"] = "LIST";
+    ActionNames["NEW"] = "NEW";
+    ActionNames["EDIT"] = "EDIT";
+})(ActionNames = exports.ActionNames || (exports.ActionNames = {}));
+var ActionTypes;
+(function (ActionTypes) {
+    ActionTypes["RECORD"] = "record";
+    ActionTypes["Resource"] = "resource";
+})(ActionTypes = exports.ActionTypes || (exports.ActionTypes = {}));
+var FieldTypes;
+(function (FieldTypes) {
+    FieldTypes["STRING"] = "String";
+    FieldTypes["NUMBER"] = "Number";
+    FieldTypes["ENUM"] = "enum";
+    FieldTypes["REFERENCE"] = "ref";
+    FieldTypes["DATE"] = "Date";
+    FieldTypes["PASSWORD"] = "password";
+    FieldTypes["BOOLEAN"] = "Boolean";
+    FieldTypes["OBJECTID"] = "ObjectID";
+    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/lib/utils/ResourceUtils.d.ts

@@ -1,2 +1,2 @@
-import { IResourceFile } from "../types/IResourceFile";
-export declare const getResource: (modelName: string, resources: IResourceFile[]) => IResourceFile | undefined;
+import { IResourceFile } from "../types/IResourceFile";
+export declare const getResource: (modelName: string, resources: IResourceFile[]) => IResourceFile | undefined;

package/lib/utils/ResourceUtils.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getResource = void 0;
-const getResource = (modelName, resources) => {
-    return resources.find(resource => resource.properties.modelName === modelName);
-};
-exports.getResource = getResource;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResource = void 0;
+const getResource = (modelName, resources) => {
+    return resources.find(resource => resource.properties.modelName === modelName);
+};
+exports.getResource = getResource;

package/lib/utils/ResponseUtils.d.ts

@@ -1,10 +1,10 @@
-import { ISaveError } from '../repositories/SaveResult';
-import { Response } from 'express';
-export default class ResponseUtils {
-    static send(res: Response, status: number, message: string, data?: object, errors?: ISaveError[]): Response<any, Record<string, any>>;
-    static created(res: Response, data: object): void;
-    static ok(res: Response, data: object): void;
-    static unauthorized(res: Response): void;
-    static unprocessable(res: Response, message: string, errors: ISaveError[]): void;
-    static notFound(res: Response, message: string, errors: ISaveError[]): void;
-}
+import { ISaveError } from '../repositories/SaveResult';
+import { Response } from 'express';
+export default class ResponseUtils {
+    static send(res: Response, status: number, message: string, data?: object, errors?: ISaveError[]): Response<any, Record<string, any>>;
+    static created(res: Response, data: object): void;
+    static ok(res: Response, data: object): void;
+    static unauthorized(res: Response): void;
+    static unprocessable(res: Response, message: string, errors: ISaveError[]): void;
+    static notFound(res: Response, message: string, errors: ISaveError[]): void;
+}

package/lib/utils/ResponseUtils.js

@@ -1,38 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ResponseUtils {
-    static send(res, status, message, data, errors) {
-        const splittedMessage = message.split(', ');
-        return res.format({
-            json: () => {
-                res.status(status).json({
-                    meta: {
-                        status,
-                        message: res.__(splittedMessage[0], { attribute: splittedMessage[1] })
-                    },
-                    data,
-                    errors
-                });
-            },
-            default: () => {
-                res.status(406).send();
-            }
-        });
-    }
-    static created(res, data) {
-        this.send(res, 201, 'Created', data);
-    }
-    static ok(res, data) {
-        this.send(res, 200, 'Ok', data);
-    }
-    static unauthorized(res) {
-        this.send(res, 401, 'Unauthenticated');
-    }
-    static unprocessable(res, message, errors) {
-        this.send(res, 422, message, {}, errors);
-    }
-    static notFound(res, message, errors) {
-        this.send(res, 404, message, {}, errors);
-    }
-}
-exports.default = ResponseUtils;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ResponseUtils {
+    static send(res, status, message, data, errors) {
+        const splittedMessage = message.split(', ');
+        return res.format({
+            json: () => {
+                res.status(status).json({
+                    meta: {
+                        status,
+                        message: res.__(splittedMessage[0], { attribute: splittedMessage[1] })
+                    },
+                    data,
+                    errors
+                });
+            },
+            default: () => {
+                res.status(406).send();
+            }
+        });
+    }
+    static created(res, data) {
+        this.send(res, 201, 'Created', data);
+    }
+    static ok(res, data) {
+        this.send(res, 200, 'Ok', data);
+    }
+    static unauthorized(res) {
+        this.send(res, 401, 'Unauthenticated');
+    }
+    static unprocessable(res, message, errors) {
+        this.send(res, 422, message, {}, errors);
+    }
+    static notFound(res, message, errors) {
+        this.send(res, 404, message, {}, errors);
+    }
+}
+exports.default = ResponseUtils;

package/lib/utils/StringUtils.d.ts

@@ -1,9 +1,9 @@
-export default class StringUtils {
-    static convertCamelCaseToWord(camelCaseWord: string): string;
-    static checkRefId(word: string): boolean;
-    static lowerCaseFirstLetter(word: string): string;
-    static upperCaseFirstLetter(word: string): string;
-    static removeResourceWord(word: string): string;
-    static getRefPath(word: string): string;
-    static getPopulatedString(populatedString: string, addedString: string): string;
-}
+export default class StringUtils {
+    static convertCamelCaseToWord(camelCaseWord: string): string;
+    static checkRefId(word: string): boolean;
+    static lowerCaseFirstLetter(word: string): string;
+    static upperCaseFirstLetter(word: string): string;
+    static removeResourceWord(word: string): string;
+    static getRefPath(word: string): string;
+    static getPopulatedString(populatedString: string, addedString: string): string;
+}

package/lib/utils/StringUtils.js

@@ -1,46 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var pluralize = require('pluralize');
-class StringUtils {
-    static convertCamelCaseToWord(camelCaseWord) {
-        if (camelCaseWord === '_id') {
-            return 'Id';
-        }
-        var result = camelCaseWord.replace(/([A-Z])/g, " $1");
-        var word = result.charAt(0).toUpperCase() + result.slice(1);
-        if (word.charAt(0) === ' ') {
-            word = word.substring(1);
-        }
-        return word;
-    }
-    static checkRefId(word) {
-        const check = word.slice(-2) === 'Id';
-        return check;
-    }
-    static lowerCaseFirstLetter(word) {
-        return word.charAt(0).toLocaleLowerCase() + word.slice(1);
-    }
-    static upperCaseFirstLetter(word) {
-        return word.charAt(0).toUpperCase() + word.slice(1);
-    }
-    static removeResourceWord(word) {
-        return this.lowerCaseFirstLetter(word.split('Resource')[0]);
-    }
-    static getRefPath(word) {
-        const check = word.slice(-2) === 'Id';
-        if (check) {
-            return word.slice(0, -2);
-        }
-        return this.lowerCaseFirstLetter(pluralize.singular(word));
-    }
-    static getPopulatedString(populatedString, addedString) {
-        if (populatedString.length === 0) {
-            populatedString = populatedString + addedString;
-        }
-        else {
-            populatedString = populatedString + ' ' + addedString;
-        }
-        return populatedString;
-    }
-}
-exports.default = StringUtils;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var pluralize = require('pluralize');
+class StringUtils {
+    static convertCamelCaseToWord(camelCaseWord) {
+        if (camelCaseWord === '_id') {
+            return 'Id';
+        }
+        var result = camelCaseWord.replace(/([A-Z])/g, " $1");
+        var word = result.charAt(0).toUpperCase() + result.slice(1);
+        if (word.charAt(0) === ' ') {
+            word = word.substring(1);
+        }
+        return word;
+    }
+    static checkRefId(word) {
+        const check = word.slice(-2) === 'Id';
+        return check;
+    }
+    static lowerCaseFirstLetter(word) {
+        return word.charAt(0).toLocaleLowerCase() + word.slice(1);
+    }
+    static upperCaseFirstLetter(word) {
+        return word.charAt(0).toUpperCase() + word.slice(1);
+    }
+    static removeResourceWord(word) {
+        return this.lowerCaseFirstLetter(word.split('Resource')[0]);
+    }
+    static getRefPath(word) {
+        const check = word.slice(-2) === 'Id';
+        if (check) {
+            return word.slice(0, -2);
+        }
+        return this.lowerCaseFirstLetter(pluralize.singular(word));
+    }
+    static getPopulatedString(populatedString, addedString) {
+        if (populatedString.length === 0) {
+            populatedString = populatedString + addedString;
+        }
+        else {
+            populatedString = populatedString + ' ' + addedString;
+        }
+        return populatedString;
+    }
+}
+exports.default = StringUtils;