adminizer 4.1.0-commit.d8a06d3 → 4.1.1

package/helpers/fieldsHelper.js

@@ -1,5 +1,6 @@
 import { DataAccessor } from "../lib/v4/DataAccessor";
 import { Adminizer } from "../lib/Adminizer";
+import { isObject } from "./JsUtils";
 export class FieldsHelper {
     /**
      * Load list of records for all associations into `fields`
@@ -20,6 +21,9 @@ export class FieldsHelper {
          */
         let loadAssoc = async function (key, action) {
             let fieldConfigConfig = fields[key].config;
+            if (!isObject(fieldConfigConfig)) {
+                throw 'type error: fieldConfigConfig should be normalized';
+            }
             if (fieldConfigConfig.type !== 'association' && fieldConfigConfig.type !== 'association-many') {
                 return;
             }
@@ -42,7 +46,7 @@ export class FieldsHelper {
                     name: modelName, config: req.adminizer.config.models[modelName],
                     model: Model, uri: `${req.adminizer.config.routePrefix}/model/${modelName}`, type: "model"
                 };
-                let dataAccessor = new DataAccessor(req, entity, action);
+                let dataAccessor = new DataAccessor(req.adminizer, req.user, entity, "view");
                 list = await Model.find({}, dataAccessor);
             }
             catch (e) {

package/helpers/inertiaAddHelper.d.ts

@@ -1,8 +1,7 @@
 import { Entity, PropsField } from "../interfaces/types";
 import { Actions } from "./inertiaActionsHelper";
-import { Fields } from "./fieldsHelper";
-import { BaseFieldConfig } from "../interfaces/adminpanelConfig";
-import { AbstractControls, ControlType } from "../lib/controls/AbstractControls";
+import { Fields, Field } from "./fieldsHelper";
+import { AbstractControls, ControlType } from "../lib/v4/controls/AbstractControls";
 export type PropsFieldType = 'text' | 'number' | 'range' | 'week' | 'month' | 'email' | 'color' | 'time' | 'date' | 'datetime-local' | 'password' | 'select' | 'select-many' | 'association-many' | 'association' | 'textarea' | 'checkbox' | ControlType;
 interface FieldProps extends Record<string | number | symbol, unknown> {
     edit: boolean;
@@ -21,7 +20,7 @@ interface FieldProps extends Record<string | number | symbol, unknown> {
     postLink: string;
 }
 export default function inertiaAddHelper(req: ReqType, entity: Entity, fields: Fields, record?: Record<string, string | boolean | number | string[]>, view?: boolean): FieldProps;
-export declare function getControlsOptions(fieldConfig: BaseFieldConfig, req: ReqType, type: ControlType, defaultControlName: string): {
+export declare function getControlsOptions(fieldConfig: Field["config"], req: ReqType, type: ControlType, defaultControlName: string): {
     name: string;
     config: {
         el?: HTMLElement;
@@ -436,7 +435,7 @@ export declare function getControlsOptions(fieldConfig: BaseFieldConfig, req: Re
     };
     path: {};
 };
-export declare function inputText(type: string, isIn: string[]): "email" | "password" | "date" | "time" | "number" | "color" | "month" | "week" | "range" | "text" | "select" | "datetime-local";
+export declare function inputText(type: string, isIn: string[]): "email" | "password" | "number" | "date" | "time" | "color" | "month" | "week" | "range" | "text" | "select" | "datetime-local";
 export declare function getControl(req: ReqType, type: ControlType, name: string | undefined, defaultControlName: string): AbstractControls;
 export declare function setSelectMany(isIn: string[], value: string[] | undefined): {
     initOptions: {

package/helpers/inertiaAddHelper.js

@@ -1,5 +1,6 @@
 import inertiaActionsHelper from "./inertiaActionsHelper";
 import chalk from "chalk";
+import { isObject } from "./JsUtils";
 export default function inertiaAddHelper(req, entity, fields, record, view = false) {
     const actionType = 'add';
     let props = {
@@ -25,6 +26,8 @@ export default function inertiaAddHelper(req, entity, fields, record, view = fal
             continue;
         let field = fields[key];
         let fieldConfig = field.config;
+        if (!isObject(fieldConfig))
+            throw `Type error: fieldConfig is object`;
         if (!!fieldConfig.visible === false)
             continue;
         const type = (fieldConfig.type || fieldConfig.type).toLowerCase();
@@ -115,6 +118,8 @@ export default function inertiaAddHelper(req, entity, fields, record, view = fal
     return props;
 }
 export function getControlsOptions(fieldConfig, req, type, defaultControlName) {
+    if (!isObject(fieldConfig))
+        throw `Type error: fieldConfig is object`;
     const fieldOptions = fieldConfig?.options;
     let control = getControl(req, type, fieldOptions?.name, defaultControlName);
     let editorName = control.getName();
@@ -192,6 +197,8 @@ function setAssociationValues(field, value) {
     let options = [];
     let initValue = [];
     const config = field.config;
+    if (!isObject(config))
+        throw `Type error: config is object`;
     const isOptionSelected = (option, value) => {
         if (Array.isArray(value)) {
             return value.includes(option);
@@ -200,8 +207,8 @@ function setAssociationValues(field, value) {
             return (option == value);
         }
     };
-    const getAssociationValue = (value, config) => {
-        const displayField = config.displayField || 'id';
+    const getAssociationValue = (value, field) => {
+        const displayField = field.modelConfig?.titleField || 'id';
         if (value === null)
             return [];
         if (Array.isArray(value)) {
@@ -214,13 +221,24 @@ function setAssociationValues(field, value) {
         return String(value);
     };
     for (let opt of config.records) {
+        const optAny = opt;
+        const displayField = typeof field.modelConfig.titleField !== 'undefined'
+            ? field.modelConfig.titleField
+            : typeof optAny.title !== 'undefined'
+                ? 'title'
+                : typeof optAny.name !== 'undefined'
+                    ? 'name'
+                    : config.identifierField;
+        const label = typeof config.displayModifier === 'function'
+            ? config.displayModifier(opt)
+            : optAny[displayField];
         options.push({
-            label: config.displayModifier && typeof config.displayModifier === 'function'
-                ? config.displayModifier(opt)
-                : (config.displayField ? opt[config.displayField] : opt[config.identifierField]),
-            value: opt[config.identifierField],
+            label,
+            value: optAny[config.identifierField],
         });
-        if (isOptionSelected(opt[config.identifierField], getAssociationValue(value, config))) {
+        if (!isObject(config))
+            throw `Type error: config is object`;
+        if (config.identifierField && isOptionSelected(opt[config.identifierField], getAssociationValue(value, field))) {
             initValue.push(opt[config.identifierField]);
         }
     }

package/helpers/inertiaFromHelper.js

@@ -9,7 +9,7 @@ export default function inertiaFormHelper(req, postLink, formData) {
     };
     for (const key of Object.keys(formData)) {
         let field = formData[key];
-        if (field.visible === false)
+        if (!!field.visible === false)
             continue;
         const type = (field.type || field.type).toLowerCase();
         const isIn = field.isIn ?? [];

package/helpers/inertiaMenuHelper.d.ts

@@ -3,6 +3,6 @@ export declare class InertiaMenuHelper {
     private adminizer;
     constructor(adminizer: Adminizer);
     getMenuItems(req: ReqType): import("./menuHelper").MenuItem[];
-    getBrandTitle(): any;
+    getBrandTitle(): string;
     getLogoutUrl(): string;
 }

package/helpers/inertiaMenuHelper.js

@@ -5,7 +5,7 @@ export class InertiaMenuHelper {
     }
     getMenuItems(req) {
         let menu = [];
-        for (const menuItem of this.adminizer.menuHelper.getMenuItems()) {
+        for (const menuItem of this.adminizer.menuHelper.getMenuItems(req.user)) {
             const menuItemTokens = menuItem.actions ? menuItem.actions.map(item => {
                 return item.accessRightsToken;
             }).filter(item => {

package/helpers/menuHelper.d.ts

@@ -3,6 +3,7 @@
  *
  * @constructor
  */
+import { UserAP } from "models/UserAP";
 import { ActionType, AdminpanelConfig, HrefConfig, ModelConfig } from "../interfaces/adminpanelConfig";
 export type MenuItem = {
     link: string;
@@ -13,16 +14,20 @@ export type MenuItem = {
     icon: string;
     accessRightsToken: string;
     entityName?: string;
+    /**
+     * Section grouping for navbar items (side navigation)
+     */
+    section?: string;
 };
 export declare class MenuHelper {
-    private static config;
+    private config;
     constructor(config: AdminpanelConfig);
     /**
      * Get menu brand title
      *
      * @returns {string}
      */
-    getBrandTitle(): any;
+    getBrandTitle(): string;
     /**
      * Check if global actions buttons added to action
      *
@@ -60,5 +65,5 @@ export declare class MenuHelper {
      *
      * @returns {Array}
      */
-    getMenuItems(): MenuItem[];
+    getMenuItems(user: UserAP): MenuItem[];
 }

package/helpers/menuHelper.js

@@ -1,7 +1,8 @@
+import { GroupsAccessRightsHelper } from "./accessRightsHelper";
 export class MenuHelper {
-    static config;
+    config;
     constructor(config) {
-        MenuHelper.config = config;
+        this.config = config;
     }
     /**
      * Get menu brand title
@@ -9,14 +10,14 @@ export class MenuHelper {
      * @returns {string}
      */
     getBrandTitle() {
-        if (!MenuHelper.config.brand || !MenuHelper.config.brand.link) {
+        if (!this.config.brand || !this.config.brand.link) {
             return 'Adminizer';
         }
-        if (typeof MenuHelper.config.brand.link === "string") {
-            return MenuHelper.config.brand.link;
+        if (typeof this.config.brand.link === "string") {
+            return this.config.brand.link;
         }
-        if (typeof MenuHelper.config.brand.link === "object" && typeof MenuHelper.config.brand.link.title === "string") {
-            return MenuHelper.config.brand.link.title;
+        if (typeof this.config.brand.link === "object" && typeof this.config.brand.link.title === "string") {
+            return this.config.brand.link.title;
         }
         return 'Adminizer';
     }
@@ -98,10 +99,10 @@ export class MenuHelper {
      *
      * @returns {Array}
      */
-    getMenuItems() {
+    getMenuItems(user) {
         let menus = [];
-        if (MenuHelper.config.navbar.additionalLinks && MenuHelper.config.navbar.additionalLinks.length > 0) {
-            MenuHelper.config.navbar.additionalLinks.forEach(function (additionalLink) {
+        if (this.config.navbar.additionalLinks && this.config.navbar.additionalLinks.length > 0) {
+            this.config.navbar.additionalLinks.forEach(function (additionalLink) {
                 if (!additionalLink.link || !additionalLink.title || additionalLink.disabled) {
                     return;
                 }
@@ -112,17 +113,24 @@ export class MenuHelper {
                     id: additionalLink.id || additionalLink.title.replace(" ", "_"),
                     actions: additionalLink.subItems || null,
                     icon: additionalLink.icon || null,
-                    accessRightsToken: additionalLink.accessRightsToken || null
+                    accessRightsToken: additionalLink.accessRightsToken || null,
+                    section: additionalLink.section || 'Platform',
                 });
             });
         }
-        if (MenuHelper.config.models) {
-            Object.entries(MenuHelper.config.models).forEach(function ([key, val]) {
-                if (!val.hide) {
+        if (this.config.models) {
+            const _this = this;
+            Object.entries(this.config.models).forEach(function ([key, val]) {
+                const hide = typeof val.navbar?.visible === 'boolean'
+                    ? !val.navbar.visible
+                    : val.navbar?.groupsAccessRights
+                        ? !GroupsAccessRightsHelper.hasAccess(user, val.navbar.groupsAccessRights)
+                        : false;
+                if (!hide) {
                     if (val.tools && val.tools.length > 0 && val.tools[0].id !== "overview") {
                         val.tools.unshift({
                             id: "overview",
-                            link: MenuHelper.config.routePrefix + '/model/' + key,
+                            link: _this.config.routePrefix + '/model/' + key,
                             title: 'Overview',
                             type: 'self',
                             icon: "list",
@@ -130,13 +138,14 @@ export class MenuHelper {
                         });
                     }
                     menus.push({
-                        link: MenuHelper.config.routePrefix + '/model/' + key,
+                        link: _this.config.routePrefix + '/model/' + key,
                         title: val.title || key,
                         icon: val.icon || null,
                         actions: val.tools || null,
                         id: val.title ? val.title.replace(" ", "_") : key,
                         entityName: key,
-                        accessRightsToken: `read-${key}-model`
+                        accessRightsToken: `read-${key}-model`,
+                        section: val.navbar?.section || 'Platform',
                     });
                 }
             });

package/index.d.ts

@@ -1,8 +1,7 @@
 export * from "./helpers/configHelper";
 export * from "./helpers/accessRightsHelper";
-export * from "./lib/installStepper/installStepper";
-export * from "./lib/widgets/widgetHandler";
-export * from "./lib/catalog/CatalogHandler";
+export * from "./lib/v4/widgets/widgetHandler";
+export * from "./lib/v4/catalog/CatalogHandler";
 export * from "./lib/media-manager/MediaManagerHandler";
 export * from "./interfaces/adminpanelConfig";
 export * from "./lib/v4/model/AbstractModel";
@@ -12,7 +11,4 @@ export * from "./lib/v4/model/adapter/sequelize";
 export * from "./lib/Adminizer";
 export * from "./models/GroupAP";
 export * from "./models/UserAP";
-export * from "./models/MediaManagerAP";
-export * from "./models/MediaManagerAssociationsAP";
-export * from "./models/MediaManagerMetaAP";
 export * from "./models/NavigationAP";

package/index.js

@@ -1,8 +1,7 @@
 export * from "./helpers/configHelper";
 export * from "./helpers/accessRightsHelper";
-export * from "./lib/installStepper/installStepper";
-export * from "./lib/widgets/widgetHandler";
-export * from "./lib/catalog/CatalogHandler";
+export * from "./lib/v4/widgets/widgetHandler";
+export * from "./lib/v4/catalog/CatalogHandler";
 export * from "./lib/media-manager/MediaManagerHandler";
 export * from "./interfaces/adminpanelConfig";
 export * from "./lib/v4/model/AbstractModel";
@@ -12,7 +11,7 @@ export * from "./lib/v4/model/adapter/sequelize";
 export * from "./lib/Adminizer";
 export * from "./models/GroupAP";
 export * from "./models/UserAP";
-export * from "./models/MediaManagerAP";
-export * from "./models/MediaManagerAssociationsAP";
-export * from "./models/MediaManagerMetaAP";
+// export * from "./models/MediaManagerAP"
+// export * from "./models/MediaManagerAssociationsAP"
+// export * from "./models/MediaManagerMetaAP"
 export * from "./models/NavigationAP";

package/interfaces/adminpanelConfig.d.ts

@@ -30,7 +30,11 @@ export interface AdminpanelConfig {
      * by default is false
      */
     auth?: {
+        /** Enable or disable authentication for admin panel */
         enable: boolean;
+        /** Enable crypto-puzzle CAPTCHA (default: true) */
+        captcha?: boolean;
+        /** Description displayed on login page */
         description?: string;
     };
     /**
@@ -39,7 +43,7 @@ export interface AdminpanelConfig {
      * reference upload contoroller ~50 line
      * */
     models: {
-        [key: string]: ModelConfig | boolean;
+        [key: string]: ModelConfig;
     };
     /**
      * For custom adminpanel sections, displays inside header
@@ -123,23 +127,6 @@ export interface AdminpanelConfig {
          * */
         set?: SetFunction;
     };
-    /**
-     * Wizards
-     * */
-    installStepper?: {
-        path: string;
-        data: {
-            [key: string]: FieldsModels;
-        };
-        /**
-         * Custom getter
-         * */
-        get?: GetFunction;
-        /**
-         * Custom setter
-         * */
-        set?: SetFunction;
-    };
     /**
      * Prime administrator login credentials
      * */
@@ -180,12 +167,6 @@ export interface AdminpanelConfig {
      *  Navigation
      */
     navigation?: NavigationConfig;
-    /**
-     *  Path to modules views
-     */
-    modulesViewsPath?: string;
-    /** @deprecated (module manager can be used it somehow) */
-    templateRootPath?: string;
     mediamanager?: MediaManagerConfig;
     /** System settings */
     system?: {
@@ -201,9 +182,23 @@ export interface ModelConfig {
      * */
     model: string;
     /**
-     * Hide entity in left navbar
+     * If the field is not definitely, then it will appear in Navbar
      * */
-    hide?: boolean;
+    navbar?: {
+        /**
+         * @default true
+         */
+        visible?: boolean;
+        /**
+         * User groups who will see the menu item
+         * For which it will be shown if not established will be shown to all groups who have the rights to read
+         */
+        groupsAccessRights?: string[];
+        /**
+         * Optional section grouping for navbar items (side navigation)
+         */
+        section?: string;
+    };
     /**
      * Entity fields configuration
      * */
@@ -230,7 +225,7 @@ export interface ModelConfig {
         filter?: {
             [key: string]: {
                 name: string;
-                criteria: any;
+                criteria: Record<string, any>;
             };
         };
     } | boolean;
@@ -258,6 +253,11 @@ export interface ModelConfig {
      * Entity icon
      * */
     icon?: MaterialIcon;
+    /**
+     * The field that will be shown for communication
+     * @default `title` or `name`
+     */
+    titleField?: string;
     /**
      * Force set primary key
      * */
@@ -266,7 +266,7 @@ export interface ModelConfig {
      *  May be association or association-many to UserAP or GroupAP */
     userAccessRelation?: {
         field: string;
-        via: string;
+        via?: string;
     } | string;
     userAccessRelationCallback?: (userWithGroups: UserWithGroups, record: any) => boolean;
 }
@@ -308,6 +308,7 @@ export interface BaseFieldConfig {
     identifierField?: string;
     /**
      * Label for associations
+     * @deprecated use model labelField prop
      * */
     displayField?: string;
     /**
@@ -407,11 +408,15 @@ export interface HrefConfig {
     /**
      * Only for view, controller still uses his own access rights token
      * */
-    accessRightsToken?: string;
+    accessRightsToken?: string | undefined;
     /**
      * For menu items only
      * */
     subItems?: HrefConfig[];
+    /**
+     * Optional section grouping for navbar items (side navigation)
+     */
+    section?: string;
 }
 export interface NavigationItemTypeConfig {
     model: string;
@@ -430,7 +435,7 @@ export interface NavigationConfig {
     }[];
     allowContentInGroup?: boolean;
     items: NavigationItemTypeConfig[];
-    movingGroupsRootOnly: boolean;
+    movingGroupsRootOnly?: boolean;
 }
 export interface MediaManagerConfig {
     allowMIME?: string[];

package/interfaces/global.d.ts

@@ -2,8 +2,8 @@ import { Adminizer } from "../lib/Adminizer";
 import { NextFunction, Request, Response } from "express";
 import multer from "multer";
 import { I18n } from "../lib/v4/I18n";
-import { Inertia } from "../lib/inertia/inertiaAdapter";
-import { Flash } from "../lib/inertia/flash";
+import { Inertia } from "../lib/v4/inertia/inertiaAdapter";
+import { Flash } from "../lib/v4/inertia/flash";
 import { UserAP } from "models/UserAP";
 declare global {
     /** @deprecated use import from TS model decalration */
@@ -75,6 +75,9 @@ declare global {
         i18n: I18n;
     };
     type ResType = Response & {
+        /**
+         * @deprecated // TODO delete after finish catalog
+         */
         viewAdmin(specifiedPath: string, locals?: any, cb_view?: Function): void;
     };
     type MiddlewareType = (req: ReqType, res: ResType, next: NextFunction) => void;

package/interfaces/types.d.ts

@@ -1,6 +1,6 @@
 import { AbstractModel } from "../lib/v4/model/AbstractModel";
 import { ModelConfig } from "./adminpanelConfig";
-export type EntityType = "form" | "model" | "wizard";
+export type EntityType = "form" | "model";
 export interface Entity {
     name: string;
     config?: ModelConfig;

package/lib/Adminizer.d.ts

@@ -4,14 +4,19 @@ import EventEmitter from 'events';
 import { AdminpanelConfig } from "../interfaces/adminpanelConfig";
 import PolicyManager from "./v4/PolicyManager";
 import { ModelHandler } from "./v4/model/ModelHandler";
-import { WidgetHandler } from "./widgets/widgetHandler";
+import { WidgetHandler } from "./v4/widgets/widgetHandler";
 import { AccessRightsHelper } from "../helpers/accessRightsHelper";
 import { ConfigHelper } from "../helpers/configHelper";
 import { AbstractAdapter } from "./v4/model/AbstractModel";
-import { ViteDevServer } from 'vite';
+import type { ViteDevServer } from 'vite';
 import { MenuHelper } from "../helpers/menuHelper";
-import { ControlsHandler } from "./controls/ControlsHandler";
+import { ControlsHandler } from "./v4/controls/ControlsHandler";
 export declare class Adminizer {
+    /**
+     * If you convey this default Middleware, it will add it to the very top of the router,
+     * and will contact each request
+     */
+    defaultMiddleware: MiddlewareType;
     app: Express;
     config: AdminpanelConfig;
     private readonly _emitter;
@@ -44,4 +49,5 @@ export declare class Adminizer {
         verbose: (...args: any[]) => winston.Logger;
         silly: (...args: any[]) => winston.Logger;
     };
+    get defaultConfig(): AdminpanelConfig;
 }