identity-admin 1.0.0

package/src/types/IResourceFile.ts

@@ -0,0 +1,240 @@
+import { Request } from "express";
+import { Document, Model } from "mongoose";
+import { ActionNames, ActionTypes, Virtuals } from "./helpers"
+
+type orderTypes = 'asc' | 'desc' 
+
+type VirtualFieldTypes = 'password' | 'ref' | 'Array'
+
+type Severity = 'success' | 'info' | 'warning' | 'error';
+
+interface Parent {
+
+    // Name of the parent
+    name: string,
+
+    // Icon of the parent. You can get the icons from https://mui.com/material-ui/material-icons/
+    icon: string
+}
+
+interface Action {
+
+    // Specify if this action is accessible or not. 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: (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: (params: any, currentUser: Document) => any;
+    }
+}
+
+export interface ActionData {
+
+    // Record document
+    record: any,
+
+    // Current user data
+    currentUser: Document,
+
+    // Resource data to which this record belongs
+    resource: {
+
+        // Model name of this table.
+        name: string,
+
+        // Path of the resource to which you can redirect.
+        path: string,
+
+        // Repository of this resource.
+        repository: any
+    }
+}
+
+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
+    scopes?: {
+
+        // Specify if this filter is accessible or not
+        isAccessible: boolean,
+
+        // This field is optional, exists only if this filter is accessible. Specify the key of field in the database that is used to filter by
+        key?: string,
+        
+        // Options that appear in the scope filter
+        options?: string[]
+    },
+    
+    // This filter is accessibile by default
+    searchBar?: {
+
+        // Specify if this filter is accessible or not
+        isAccessible: boolean,
+    }
+}
+
+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. If not mentioned it will be set as the schema.
+     required?: boolean,
+
+     // Specify either this field can be edited or not.
+    isEditable?: boolean
+}
+
+interface IVirtualValue {
+
+    // For now this feature is supported for password field, if you want to add password field in the create form for example, and ref which means that 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
+    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
+}
+
+interface IModel {
+
+    // Add virtual data
+    virtuals?: {[key:string]: IVirtualValue}
+}
+interface ActionOptions {
+
+    show?: Action,
+    new?: Action,
+    edit?: Action, 
+    delete?: Action,
+    bulkDelete?: Action,
+
+    // Any extra action that is required to be added.
+    extras?: ExtraAction[]
+}
+
+interface ExtraAction {
+
+    // Key of this action which must 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: 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?: 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
+
+    // Is visibile function returns a boolean that specifies to which records should this action appears. Action is shown to all records by default
+    isVisible?: (data: ActionData) => boolean;
+
+    // Handler function that is executed after clicking the action.
+    handler: (req: Request, res: any, data: ActionData) => Promise<any> 
+
+        // The action in which is redirected to 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 go 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: {
+
+        // Model 
+        resource: Model<any, any>,
+
+        // Model name should be set here. This field is required
+        modelName: string,
+
+        // Name of this model appeared on the nav bar. If not mentioned the model name is taken.
+        name?: string,
+
+        // Property of this table that is shown as the link and 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, email). If not found _id is taken.
+        title?: string,
+
+        // The property of this model that is used in the default sort at the beginning. If not mentioned is set by the schema's title.
+        defaultOrderBy?: string,
+
+        //Number of rows per page. If not mentioned, it is set to 10.
+        defaultrowsPerPage?: number,
+
+        // The default order if ascending or descending. Ascending is the default.
+        defaultOrder?: orderTypes,
+
+        //The parent that this model is belong to in the nav bar. Setup parent is the default.
+        parent?: Parent
+
+        // Array of fields that are completely hidden from all properties
+        hiddenProperties?: string[],
+
+        // Main actions accessibility are overriden here, also you can customize new action here
+        actions?: ActionOptions,
+
+        // Override filters here
+        filters?: IFilters
+
+        // Override before handler for list and create here
+        crudOperations?: ICrudOperations,
+
+        // Translations of fields
+        keysTranslations?:  {[key:string]: any};
+
+        // Translations od actions
+        actionsTranslations?:  {[key:string]: any};
+
+        // Override some props of a field's schema structure or create a new virtual property
+        model?: {[key:string]: IFieldValue} | IModel
+
+    },
+
+    // Array of properties that should be appeared in the list action. If not set the whole record is listed
+    listProperties?: string[],	
+    
+    // Arrays of properties that should be appeared in the show action. If not set the whole record is shown
+    showProperties?: string[],
+        
+    // Array of properties that should be appeared in the create/edit form. If not set the whole record is shown in the form
+    formProperties?: string[]
+
+
+}

package/src/types/helpers.ts

@@ -0,0 +1,17 @@
+export enum Virtuals {
+    SHOW = 'SHOW',
+    LIST = 'LIST',
+    FORM = 'FORM'
+}
+
+export enum ActionNames {
+    SHOW = 'SHOW',
+    LIST = 'LIST',
+    NEW = 'NEW',
+    EDIT = 'EDIT'
+}
+
+export enum ActionTypes {
+    RECORD = 'record',
+    Resource = 'resource'
+}

package/src/utils/ResourceUtils.ts

@@ -0,0 +1,5 @@
+import { IResourceFile } from "../types/IResourceFile";
+
+export const getResource = (modelName: string, resources: IResourceFile[]): IResourceFile | undefined => {
+  return resources.find(resource => resource.properties.modelName === modelName);
+}

package/src/utils/ResponseUtils.ts

@@ -0,0 +1,68 @@
+import { IRequestLogProps } from '../models/request-log/IRequestLog';
+import RequestLogRepository, { IRequestLogRepository } from '../repositories/RequestLogRepository';
+import { ISaveError } from '../repositories/SaveResult';
+import { Response } from 'express';
+
+export default class ResponseUtils {
+    private static logRepository = new RequestLogRepository();
+
+    public static send(res: Response, status: number, message: string, data?: object, errors?: ISaveError []) {
+        
+        this.log(res.req, status, message);
+        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();
+            }
+        });
+    }
+
+    public static created(res: Response, data: object) {
+        this.send(res, 201, 'Created', data);
+    }
+
+    public static ok(res: Response, data: object) {
+        this.send(res, 200, 'Ok', data);
+    }
+
+    public static unauthorized(res: Response) {
+        this.send(res, 401, 'Unauthenticated')
+    } 
+
+    public static unprocessable(res: Response, message: string, errors: ISaveError[]) {
+        this.send(res, 422, message, {}, errors)
+    }
+
+    public static notFound(res: Response, message: string, errors: ISaveError[]) {
+        this.send(res, 404, message, {}, errors);
+    }
+
+    private static async log(req: any, status: number, message: string): Promise<void> {
+        const duration = new Date().getTime() - req.startTime.getTime();
+        const logProps: IRequestLogProps = {
+            method: req.method,
+            endpoint: req.route.path,
+            url: req.originalUrl.split('?')[0],
+            startTime: req.startTime,
+            durationInMilliseconds: duration,
+            query: JSON.stringify(req.query),
+            body: JSON.stringify(req.body),
+            userAgent: req.headers['user-agent'],
+            headers: JSON.stringify(req.headers),
+            status: status,
+            message: message
+        };
+        await ResponseUtils.logRepository.save(logProps);
+    }
+    
+}

package/src/utils/StringUtils.ts

@@ -0,0 +1,63 @@
+var pluralize = require('pluralize')
+
+export default class StringUtils {
+
+    public static convertCamelCaseToWord(camelCaseWord: string ) {
+        
+        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
+    }
+
+    public static checkRefId(word: string ) {
+        const check = word.slice(-2) === 'Id'
+        return check
+    }
+
+    public static lowerCaseFirstLetter(word: string) {
+        return word.charAt(0).toLocaleLowerCase() + word.slice(1);
+    }
+
+    public static upperCaseFirstLetter(word: string) {
+        return word.charAt(0).toUpperCase() + word.slice(1);
+    }
+
+    public static removeResourceWord(word: string) {
+        return this.lowerCaseFirstLetter(word.split('Resource')[0])
+    }
+
+    public static getRefPath(word: string) {
+
+        const check = word.slice(-2) === 'Id'
+
+        if (check) {
+            return word.slice(0, -2)
+        }
+
+        return this.lowerCaseFirstLetter(pluralize.singular(word)) 
+    }
+
+    public static getPopulatedString(populatedString: string, addedString: string) {
+
+        if (populatedString.length === 0) {
+            populatedString = populatedString + addedString
+        }
+
+        else {
+            populatedString = populatedString + ' ' + addedString
+        }
+
+        return populatedString
+        
+    }
+
+
+}
+

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,  
+    "target": "es2016",                                  
+    "module": "commonjs",                                
+    "esModuleInterop": true,   
+    "declaration": true,                       
+    "forceConsistentCasingInFileNames": true,         
+    "outDir": "./lib",   
+    "strict": true,   
+    "watch": false                                
+  },
+
+  "include": ["src", "lib/view"],
+  "exclude": ["node_modules", "**/__tests__/*"]
+
+}