identity-admin 1.9.1 → 1.10.0

package/lib/types/IResourceFile.d.ts

@@ -1,71 +1,72 @@
 import { Request } from "express";
 import { Document, Model } from "mongoose";
 import { IRequest } from "../middlewares/isAuth";
-import { ActionTypes, FieldTypes, Virtuals } from "./helpers";
+import { IRepository } from "../repositories/Repository";
+import { ActionNames, ActionTypes, FieldTypes, FileTypes, 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 of the parent
+     */
     name: string;
     /**
-    * Icon of the parent. You can get the icons from
-    * @link https://mui.com/material-ui/material-icons/
-    */
+     * 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.
-    */
+     * Specify if this action is accessible or not.
+     * @default True for show, edit, delete, and new.
+     * @default 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: {
+         * 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.
+         * @returns the filter object
+         */
+        before?: (req: IRequest, filter: {
             [key: string]: any;
-        }, currentUser: Document) => {
+        }, currentUser: Document) => Promise<{
             [key: string]: any;
-        };
+        }>;
+        /**
+         * After handler that gives you the access to the array of documents.
+         * @returns the array of documents
+         */
+        after?: (req: IRequest, documents: Document[], currentUser: Document) => Promise<Document[]>;
     };
     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;
+         * 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.
+         * @returns the params
+         */
+        before?: (req: IRequest, params: any, currentUser: Document) => Promise<any>;
+        /**
+         * After handler that gives you the access to the saved document.
+         * @returns the saved document
+         */
+        after?: (req: IRequest, document: Document, currentUser: Document) => Promise<Document>;
+    };
+    update?: {
+        /**
+         * Before handler that is called before updating a 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.
+         * @returns the params
+         */
+        before?: (req: IRequest, params: any, currentUser: Document) => Promise<any>;
     };
     show?: {
-        after: (req: IRequest, record: Document) => Promise<{
+        after?: (req: IRequest, record: Document) => Promise<{
             record: Document;
             [key: string]: any;
         }>;
@@ -73,74 +74,154 @@ interface ICrudOperations {
 }
 export interface ActionData {
     /**
-    * Record document
-    */
+     * Record document
+     */
     record: any;
     /**
-    * Current user data
-    */
+     * Current user data
+     */
     currentUser: Document;
     /**
-    * Resource data to which this record belongs
-    */
+     * Resource data to which this record belongs
+     */
     resource: {
         /**
-        * Model name of this table.
-        */
+         * Model name of this table.
+         */
         name: string;
         /**
-        * Path of the resource to which you can redirect.
-        */
+         * Path of the resource to which you can redirect.
+         */
         path: string;
         /**
-        * Repository of this resource.
-        */
-        repository: any;
+         * Repository of this resource.
+         */
+        repository: IRepository<Document>;
     };
 }
 interface IFilters {
     /**
-    * Scope filter props. If used you should override the scope filter function in the controller of this resource. This filter is not accessible by default
-    */
+     * Scope filter props.
+     * Can be either auto or manual. It cannot be both.
+     * This filter is not accessible by default
+     */
     scopes?: {
         /**
         * 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
-        */
+         * 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.
+         * It doesn't need a handler
+         */
         auto?: IAutoScope;
         /**
-        * Manual scope by using a handler
-        */
+         * Manual scope by using a handler.
+         * In this case you can put the options you like with specifying in the handler what to do with each option.
+         */
         manual?: IManualScope;
     };
+    /**
+     * Search bar filter props
+     */
     searchBar?: {
+        /**
+        * Specify if this filter is accessible or not
+        * @default true
+        */
         isAccessible: boolean;
     };
 }
+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) => Promise<{
+        [key: string]: any;
+    }>;
+}
 export interface IFieldValue {
+    /**
+     * If the field is required in the schema and you don't want it to be required in the form, you can override this here.
+     * @default 'same as schema'
+     */
     required?: boolean;
+    /**
+     * Specify either this field can be edited or not.
+     * @default true
+     */
     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", ...]
-    */
+     * Specify the type of the field. Can be used for specifying localized string, image,... etc.
+     * @default 'Same as schema''
+     */
+    type?: FieldTypes;
+    /**
+     * Specify the allowed country codes.
+     * @required if the type is phone number
+     * ex: ["sa", "eg", ...]
+     */
     countryCodes?: string[];
+    /**
+     * Specify the array type if the field is of type array.
+     * @default 'Same as schema''
+     */
     arrayType?: FieldTypes;
+    /**
+     * Can be used only if this field is a reference to the Image collection
+     */
     mediaUploader?: boolean;
+    /**
+     * Specify the type of the file to be uploaded. Only required if the media uploader is true.
+     * @default image
+     */
+    fileType?: FileTypes;
 }
 export interface IVirtualValue {
+    /**
+     * For now we have some virtual fields that can be added
+     * 1) Password: If you want to add password field in the creation form for example
+     * 2) ref: If it is a one to many realtion. For example, if you want to get all subCatogeries that belong to a category when you show the category record
+     * 3) array: If this field is an array
+     */
     type: VirtualFieldTypes;
+    /**
+     * Array type exists only if the type is array
+     */
     arrayType?: string;
+    /**
+     * Defines where this virtaul field need to be appeared
+     */
     showIn: Virtuals;
     required: boolean;
+    /**
+     * Define Virtual field's resource in case of ref type or array of ref type
+     */
     resource?: Model<any, any>;
 }
 interface IModel {
+    /**
+     * virtual data props
+     */
     virtuals?: {
         [key: string]: IVirtualValue;
     };
@@ -151,62 +232,169 @@ interface ActionOptions {
     edit?: Action;
     delete?: Action;
     bulkDelete?: Action;
+    /**
+     * Any extra action to be added.
+     */
     extras?: ExtraAction[];
 }
 interface ExtraAction {
+    /**
+     * Key of this action.
+     * Should be unique in the same resource file
+     */
     key: string;
+    /**
+     * Name of this action
+     */
     name: string;
     /**
-    * Icon of this action.
-    * @reference 'https://mui.com/material-ui/material-icons/'
-    */
+     * Icon of this action.
+     * {@link https://mui.com/material-ui/material-icons/}
+     */
     icon: string;
+    /**
+     * Action type if it is record action or resource action.
+     */
     actionType: ActionTypes;
     /**
-    * Guard message that appears before executing the action to confirm execution.
-    * @default 'No guard message'
-    */
+     * 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'
+     * 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'
-   */
+     * 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>;
+    /**
+     * @returns boolean value.
+     * This value Specifies to which records should this action appears.
+     * @default 'Action is shown to all records'
+     */
+    isVisible?: (data: ActionData) => Promise<boolean>;
+    /**
+     * Handler function that is executed after clicking the action.
+     */
+    handler: (req: Request, res: any, data: ActionData) => Promise<IActionHandlerResponse>;
+}
+export interface IActionHandlerResponse {
+    /**
+     * The action taken after executing the action.
+     * For example, if you would like to go to list after executing the action, just set this value by list
+     */
+    action: ActionNames;
+    /**
+     * Path of the resource that is intended to redirect.
+     * Is set to resource.path if you would like to be in the same table
+     */
+    path: string;
+    /**
+     * Id of the record that is used in actions that needs record id like show or edit
+     */
+    recordId?: string;
 }
 export interface IResourceFile {
     properties: {
+        /**
+         * The model
+         */
         resource: Model<any, any>;
+        /**
+         * Model name as saved in the data base.
+         */
         modelName: string;
+        /**
+         * Name of this model appeared on the nav bar.
+         * @default 'Model name'
+         */
         name?: string;
+        /**
+         * Property of this table that is shown as the link for the record.
+         * Used to be searched by in the search bar.
+         * If not mentioned explicitly, a search is done on the schema to check for property title, name, or email.
+         * If these properties are not found, _id is taken.
+         */
         title?: string;
+        /**
+         * The property to be sorted by the documents.
+         * @default 'The schema title'
+         */
         defaultOrderBy?: string;
-        defaultrowsPerPage?: number;
+        /**
+         * The default order
+         * @default asc
+         */
         defaultOrder?: orderTypes;
+        /**
+         * Number of rows per page
+         * @default 10
+         */
+        defaultrowsPerPage?: number;
+        /**
+         * The parent that this model is belong to in the nav bar.
+         * @default 'Set up parent'
+         */
         parent?: Parent;
+        /**
+         * Array of fields that are completely hidden from all pages
+         */
         hiddenProperties?: string[];
+        /**
+         * Action options for overriding existing actions accessibility or adding custom actions
+         */
         actions?: ActionOptions;
+        /**
+         * Filters options
+         */
         filters?: IFilters;
+        /**
+         * Using before or after handlers of any crud operation
+         */
         crudOperations?: ICrudOperations;
+        /**
+         * Translation object of the fields' names.
+         */
         keysTranslations?: {
             [key: string]: any;
         };
+        /**
+         * Translation object of the actions' names.
+         */
         actionsTranslations?: {
             [key: string]: any;
         };
+        /**
+         * Override some props of a field's schema structure
+         * Add a new virtual property
+         */
         model?: {
             [key: string]: IFieldValue;
         } | IModel;
     };
+    /**
+    * 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.
+     * @default 'The whole fields'
+     */
     showProperties?: string[];
+    /**
+     * Array of properties that should be appeared in the create/edit form.
+     * @default 'The whole fields'
+     */
     formProperties?: string[];
+    /**
+     * Array of properties that should be appeared in the filter.
+     * @default 'The whole fields'
+     */
     filterProperties?: string[];
 }
 export {};

package/lib/types/IResourceResponse.d.ts

@@ -0,0 +1,99 @@
+import { ActionTypes } from "./helpers";
+export default interface IResourceResponse {
+    filterProperties: string[];
+    formProperties: string[];
+    listProperties: IProperty[];
+    showProperties: IProperty[];
+    properties: IMainProperty;
+}
+interface IProperty {
+    key: string;
+    value: string;
+    path?: string;
+}
+interface IMainProperty {
+    title: string;
+    path: string;
+    name: string;
+    modelName: string;
+    parent: IParent;
+    defaultOrder: orderTypes;
+    defaultOrderBy: string;
+    defaultrowsPerPage: number;
+    filters: IFilter;
+    actions: IAction;
+    model: {
+        [key: string]: any;
+    };
+}
+interface IParent {
+    icon: string;
+    name: string;
+    value: string;
+}
+interface IFilter {
+    scopes: {
+        isAccessible: boolean;
+        options?: {
+            key: string;
+            value: string;
+        }[];
+        manual?: {
+            options: string[];
+        };
+        auto?: {
+            key: string;
+            options: string[];
+        };
+    };
+    searchBar: {
+        isAccessible: boolean;
+    };
+}
+interface IAction {
+    bulkDelete: {
+        cancelDeleteOption: string;
+        confirmDeleteOption: string;
+        confirmationMessageBody: string;
+        confirmationMessageTitle: string;
+        isAccessible: boolean;
+        value: string;
+    };
+    delete: {
+        cancelDeleteOption: string;
+        confirmDeleteOption: string;
+        confirmationMessageBody: string;
+        confirmationMessageTitle: string;
+        isAccessible: boolean;
+        value: string;
+    };
+    edit: IActionMin;
+    new: IActionMin;
+    show: IActionMin;
+    extras?: IExtras;
+}
+interface IExtras {
+    record: {
+        [key: string]: IExtarAction;
+    };
+    resource: {
+        [key: string]: IExtarAction;
+    };
+}
+interface IExtarAction {
+    actionType: ActionTypes;
+    guard?: string;
+    icon: string;
+    key: string;
+    keys?: string[];
+    name: string;
+    severity?: Severity;
+    message?: string;
+}
+interface IActionMin {
+    isAccessible: boolean;
+    value?: string;
+}
+declare type orderTypes = 'asc' | 'desc';
+declare type Severity = 'success' | 'info' | 'warning' | 'error';
+export {};

package/lib/types/IResourceResponse.js

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

package/lib/types/helpers.d.ts

@@ -30,3 +30,15 @@ export declare enum FieldTypes {
     COLOR = "color",
     TIMEPICKER = "timePicker"
 }
+export declare enum FileTypes {
+    IMAGE = "IMAGE",
+    _3D = "3D",
+    PDF = "PDF",
+    EXCEL = "EXCEL",
+    WORD = "WORD",
+    VIDEO = "VIDEO",
+    TEXT = "TEXT",
+    ZIP = "ZIP",
+    POWER_POINT = "POWER_POINT",
+    AUDIO = "AUDIO"
+}

package/lib/types/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldTypes = exports.ActionTypes = exports.ActionNames = exports.Virtuals = void 0;
+exports.FileTypes = exports.FieldTypes = exports.ActionTypes = exports.ActionNames = exports.Virtuals = void 0;
 var Virtuals;
 (function (Virtuals) {
     Virtuals["SHOW"] = "SHOW";
@@ -37,3 +37,16 @@ var FieldTypes;
     FieldTypes["COLOR"] = "color";
     FieldTypes["TIMEPICKER"] = "timePicker";
 })(FieldTypes = exports.FieldTypes || (exports.FieldTypes = {}));
+var FileTypes;
+(function (FileTypes) {
+    FileTypes["IMAGE"] = "IMAGE";
+    FileTypes["_3D"] = "3D";
+    FileTypes["PDF"] = "PDF";
+    FileTypes["EXCEL"] = "EXCEL";
+    FileTypes["WORD"] = "WORD";
+    FileTypes["VIDEO"] = "VIDEO";
+    FileTypes["TEXT"] = "TEXT";
+    FileTypes["ZIP"] = "ZIP";
+    FileTypes["POWER_POINT"] = "POWER_POINT";
+    FileTypes["AUDIO"] = "AUDIO";
+})(FileTypes = exports.FileTypes || (exports.FileTypes = {}));

package/lib/view/asset-manifest.json

@@ -1,14 +1,19 @@
 {
   "files": {
-    "main.css": "/static/css/main.18dca458.css",
-    "main.js": "/static/js/main.da8f09ec.js",
-    "static/js/148.b05fe2c8.chunk.js": "/static/js/148.b05fe2c8.chunk.js",
-    "static/js/705.f86db82e.chunk.js": "/static/js/705.f86db82e.chunk.js",
-    "static/js/802.3f287a2c.chunk.js": "/static/js/802.3f287a2c.chunk.js",
-    "index.html": "/index.html"
+    "main.css": "/static/css/main.54de06ef.css",
+    "main.js": "/static/js/main.7ca1e0c1.js",
+    "static/js/574.778b5963.chunk.js": "/static/js/574.778b5963.chunk.js",
+    "static/js/678.521704a3.chunk.js": "/static/js/678.521704a3.chunk.js",
+    "static/js/798.54856416.chunk.js": "/static/js/798.54856416.chunk.js",
+    "index.html": "/index.html",
+    "main.54de06ef.css.map": "/static/css/main.54de06ef.css.map",
+    "main.7ca1e0c1.js.map": "/static/js/main.7ca1e0c1.js.map",
+    "574.778b5963.chunk.js.map": "/static/js/574.778b5963.chunk.js.map",
+    "678.521704a3.chunk.js.map": "/static/js/678.521704a3.chunk.js.map",
+    "798.54856416.chunk.js.map": "/static/js/798.54856416.chunk.js.map"
   },
   "entrypoints": [
-    "static/css/main.18dca458.css",
-    "static/js/main.da8f09ec.js"
+    "static/css/main.54de06ef.css",
+    "static/js/main.7ca1e0c1.js"
   ]
 }