adminforth 1.2.1 → 1.2.3

package/dist/modules/configValidator.js

@@ -0,0 +1,408 @@
+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());
+    });
+};
+import { AdminForthResourcePages, AllowedActionsEnum, } from "../types/AdminForthConfig.js";
+import fs from 'fs';
+import path from 'path';
+import { guessLabelFromName } from './utils.js';
+import { v4 as uuid } from 'uuid';
+export default class ConfigValidator {
+    constructor(adminforth, config) {
+        this.adminforth = adminforth;
+        this.config = config;
+        this.adminforth = adminforth;
+        this.config = config;
+    }
+    checkCustomFileExists(filePath) {
+        if (filePath.startsWith('@@/')) {
+            const checkPath = path.join(this.config.customization.customComponentsDir, filePath.replace('@@/', ''));
+            if (!fs.existsSync(checkPath)) {
+                return [`File file ${filePath} does not exist in ${this.config.customization.customComponentsDir}`];
+            }
+        }
+        return [];
+    }
+    validateComponent(component, errors, ignoreExistsCheck = false) {
+        if (!component) {
+            return component;
+        }
+        let obj;
+        if (typeof component === 'string') {
+            obj = { file: component, meta: {} };
+        }
+        else {
+            obj = component;
+        }
+        if (!ignoreExistsCheck) {
+            errors.push(...this.checkCustomFileExists(obj.file));
+        }
+        return obj;
+    }
+    validateConfig() {
+        var _a;
+        const errors = [];
+        if (this.config.rootUser) {
+            if (!this.config.rootUser.username) {
+                throw new Error('rootUser.username is required');
+            }
+            if (!this.config.rootUser.password) {
+                throw new Error('rootUser.password is required');
+            }
+            console.log('\n ⚠️⚠️⚠️ [INSECURE ALERT] config.rootUser is set, please create a new user and remove config.rootUser from config ASAP when you are in production\n');
+        }
+        if (!this.config.customization.customComponentsDir) {
+            this.config.customization.customComponentsDir = './custom';
+        }
+        try {
+            // check customComponentsDir exists
+            fs.accessSync(this.config.customization.customComponentsDir, fs.constants.R_OK);
+        }
+        catch (e) {
+            this.config.customization.customComponentsDir = undefined;
+        }
+        if (this.config.auth) {
+            if (!this.config.auth.resourceId) {
+                throw new Error('No config.auth.resourceId defined');
+            }
+            if (!this.config.auth.passwordHashField) {
+                throw new Error('No config.auth.passwordHashField defined');
+            }
+            if (!this.config.auth.usernameField) {
+                throw new Error('No config.auth.usernameField defined');
+            }
+            if (this.config.auth.loginBackgroundImage) {
+                errors.push(...this.checkCustomFileExists(this.config.auth.loginBackgroundImage));
+            }
+            const userResource = this.config.resources.find((res) => res.resourceId === this.config.auth.resourceId);
+            if (!userResource) {
+                throw new Error(`Resource with id "${this.config.auth.resourceId}" not found`);
+            }
+            if (!this.config.auth.beforeLoginConfirmation) {
+                this.config.auth.beforeLoginConfirmation = [];
+            }
+        }
+        if (!this.config.customization) {
+            this.config.customization = {};
+        }
+        if (!this.config.customization.customComponentsDir) {
+            this.config.customization.customComponentsDir = './custom';
+        }
+        try {
+            // check customComponentsDir exists
+            fs.accessSync(this.config.customization.customComponentsDir, fs.constants.R_OK);
+        }
+        catch (e) {
+            this.config.customization.customComponentsDir = undefined;
+        }
+        if (this.config.customization.customPages) {
+            this.config.customization.customPages.forEach((page, i) => {
+                // validate component if it's not plugin injection
+                if (this.adminforth.codeInjector.allComponentNames.hasOwnProperty(page.component)) {
+                    const validatedPage = this.validateComponent(page.component, errors, true);
+                }
+            });
+        }
+        else {
+            this.config.customization.customPages = [];
+        }
+        if (!this.config.baseUrl) {
+            this.config.baseUrl = '';
+        }
+        if (!this.config.baseUrl.endsWith('/')) {
+            this.adminforth.baseUrlSlashed = this.config.baseUrl + '/';
+        }
+        else {
+            this.adminforth.baseUrlSlashed = this.config.baseUrl;
+        }
+        if (((_a = this.config) === null || _a === void 0 ? void 0 : _a.customization.brandName) === undefined) {
+            this.config.customization.brandName = 'AdminForth';
+        }
+        if (this.config.customization.brandLogo) {
+            errors.push(...this.checkCustomFileExists(this.config.customization.brandLogo));
+        }
+        if (this.config.customization.favicon) {
+            errors.push(...this.checkCustomFileExists(this.config.customization.favicon));
+        }
+        if (!this.config.customization.datesFormat) {
+            this.config.customization.datesFormat = 'MMM D, YYYY HH:mm:ss';
+        }
+        if (this.config.resources) {
+            this.config.resources.forEach((res) => {
+                var _a, _b, _c;
+                if (!res.table) {
+                    errors.push(`Resource "${res.dataSource}" is missing table`);
+                }
+                // if recordLabel is not callable, throw error
+                if (res.recordLabel && typeof res.recordLabel !== 'function') {
+                    errors.push(`Resource "${res.dataSource}" recordLabel is not a function`);
+                }
+                if (!res.recordLabel) {
+                    res.recordLabel = (item) => {
+                        const pkVal = item[res.columns.find((col) => col.primaryKey).name];
+                        return `${res.label} ${pkVal}`;
+                    };
+                }
+                res.resourceId = res.resourceId || res.table;
+                res.label = res.label || res.table.charAt(0).toUpperCase() + res.table.slice(1);
+                if (!res.dataSource) {
+                    errors.push(`Resource "${res.resourceId}" is missing dataSource`);
+                }
+                if (!res.columns) {
+                    res.columns = [];
+                }
+                res.columns.forEach((col) => {
+                    var _a, _b, _c, _d;
+                    col.label = col.label || guessLabelFromName(col.name);
+                    //define default sortable
+                    if (!Object.keys(col).includes('sortable')) {
+                        col.sortable = true;
+                    }
+                    if (col.showIn && !Array.isArray(col.showIn)) {
+                        errors.push(`Resource "${res.resourceId}" column "${col.name}" showIn must be an array`);
+                    }
+                    // check col.required is string or object
+                    if (col.required && !((typeof col.required === 'boolean') || (typeof col.required === 'object'))) {
+                        errors.push(`Resource "${res.resourceId}" column "${col.name}" required must be a string or object`);
+                    }
+                    // if it is object check the keys are one of ['create', 'edit']
+                    if (typeof col.required === 'object') {
+                        const wrongRequiredOn = Object.keys(col.required).find((c) => !['create', 'edit'].includes(c));
+                        if (wrongRequiredOn) {
+                            errors.push(`Resource "${res.resourceId}" column "${col.name}" has invalid required value "${wrongRequiredOn}", allowed keys are 'create', 'edit']`);
+                        }
+                    }
+                    // same for editingNote
+                    if (col.editingNote && !((typeof col.editingNote === 'string') || (typeof col.editingNote === 'object'))) {
+                        errors.push(`Resource "${res.resourceId}" column "${col.name}" editingNote must be a string or object`);
+                    }
+                    if (typeof col.editingNote === 'object') {
+                        const wrongEditingNoteOn = Object.keys(col.editingNote).find((c) => !['create', 'edit'].includes(c));
+                        if (wrongEditingNoteOn) {
+                            errors.push(`Resource "${res.resourceId}" column "${col.name}" has invalid editingNote value "${wrongEditingNoteOn}", allowed keys are 'create', 'edit']`);
+                        }
+                    }
+                    const wrongShowIn = col.showIn && col.showIn.find((c) => AdminForthResourcePages[c] === undefined);
+                    if (wrongShowIn) {
+                        errors.push(`Resource "${res.resourceId}" column "${col.name}" has invalid showIn value "${wrongShowIn}", allowed values are ${Object.keys(AdminForthResourcePages).join(', ')}`);
+                    }
+                    col.showIn = col.showIn || Object.values(AdminForthResourcePages);
+                    if (col.foreignResource) {
+                        const befHook = (_b = (_a = col.foreignResource.hooks) === null || _a === void 0 ? void 0 : _a.dropdownList) === null || _b === void 0 ? void 0 : _b.beforeDatasourceRequest;
+                        if (befHook) {
+                            if (!Array.isArray(befHook)) {
+                                col.foreignResource.hooks.dropdownList.beforeDatasourceRequest = [befHook];
+                            }
+                        }
+                        const aftHook = (_d = (_c = col.foreignResource.hooks) === null || _c === void 0 ? void 0 : _c.dropdownList) === null || _d === void 0 ? void 0 : _d.afterDatasourceResponse;
+                        if (aftHook) {
+                            if (!Array.isArray(aftHook)) {
+                                col.foreignResource.hooks.dropdownList.afterDatasourceResponse = [aftHook];
+                            }
+                        }
+                    }
+                });
+                if (!res.options) {
+                    res.options = { bulkActions: [], allowedActions: {} };
+                }
+                if (!res.options.allowedActions) {
+                    res.options.allowedActions = {
+                        all: true,
+                    };
+                }
+                if (Object.keys(res.options.allowedActions).includes('all')) {
+                    if (Object.keys(res.options.allowedActions).length > 1) {
+                        errors.push(`Resource "${res.resourceId}" allowedActions cannot have "all" and other keys at same time: ${Object.keys(res.options.allowedActions).join(', ')}`);
+                    }
+                    for (const key of Object.keys(AllowedActionsEnum)) {
+                        if (key !== 'all') {
+                            res.options.allowedActions[key] = res.options.allowedActions.all;
+                        }
+                    }
+                    delete res.options.allowedActions.all;
+                }
+                else {
+                    // by default allow all actions
+                    for (const key of Object.keys(AllowedActionsEnum)) {
+                        if (!Object.keys(res.options.allowedActions).includes(key)) {
+                            res.options.allowedActions[key] = true;
+                        }
+                    }
+                }
+                //check if resource has bulkActions
+                let bulkActions = ((_a = res === null || res === void 0 ? void 0 : res.options) === null || _a === void 0 ? void 0 : _a.bulkActions) || [];
+                if (!Array.isArray(bulkActions)) {
+                    errors.push(`Resource "${res.resourceId}" bulkActions must be an array`);
+                    bulkActions = [];
+                }
+                if (((_c = (_b = res.options) === null || _b === void 0 ? void 0 : _b.allowedActions) === null || _c === void 0 ? void 0 : _c.delete) && !bulkActions.find((action) => action.label === 'Delete checked')) {
+                    bulkActions.push({
+                        label: `Delete checked`,
+                        state: 'danger',
+                        icon: 'flowbite:trash-bin-outline',
+                        action: (_d) => __awaiter(this, [_d], void 0, function* ({ selectedIds }) {
+                            const connector = this.adminforth.connectors[res.dataSource];
+                            yield Promise.all(selectedIds.map((recordId) => __awaiter(this, void 0, void 0, function* () {
+                                yield connector.deleteRecord({ resource: res, recordId });
+                            })));
+                        })
+                    });
+                }
+                const newBulkActions = bulkActions.map((action) => {
+                    return Object.assign(action, { id: uuid() });
+                });
+                res.options.bulkActions = newBulkActions;
+                // if pageInjection is a string, make array with one element. Also check file exists
+                const possibleInjections = ['beforeBreadcrumbs', 'afterBreadcrumbs', 'bottom'];
+                if (res.options.pageInjections) {
+                    Object.entries(res.options.pageInjections).map(([key, value]) => {
+                        Object.entries(value).map(([injection, target]) => {
+                            if (possibleInjections.includes(injection)) {
+                                if (!Array.isArray(res.options.pageInjections[key][injection])) {
+                                    // not array
+                                    res.options.pageInjections[key][injection] = [target];
+                                }
+                                res.options.pageInjections[key][injection].forEach((target, i) => {
+                                    res.options.pageInjections[key][injection][i] = this.validateComponent(target, errors);
+                                });
+                            }
+                            else {
+                                errors.push(`Resource "${res.resourceId}" has invalid pageInjection key "${injection}", Supported keys are ${possibleInjections.join(', ')}`);
+                            }
+                        });
+                    });
+                }
+                // transform all hooks Functions to array of functions
+                if (!res.hooks) {
+                    res.hooks = {};
+                }
+                for (const hookName of ['show', 'list']) {
+                    if (!res.hooks[hookName]) {
+                        res.hooks[hookName] = {};
+                    }
+                    if (!res.hooks[hookName].beforeDatasourceRequest) {
+                        res.hooks[hookName].beforeDatasourceRequest = [];
+                    }
+                    if (!Array.isArray(res.hooks[hookName].beforeDatasourceRequest)) {
+                        res.hooks[hookName].beforeDatasourceRequest = [res.hooks[hookName].beforeDatasourceRequest];
+                    }
+                    if (!res.hooks[hookName].afterDatasourceResponse) {
+                        res.hooks[hookName].afterDatasourceResponse = [];
+                    }
+                    if (!Array.isArray(res.hooks[hookName].afterDatasourceResponse)) {
+                        res.hooks[hookName].afterDatasourceResponse = [res.hooks[hookName].afterDatasourceResponse];
+                    }
+                }
+                for (const hookName of ['create', 'edit', 'delete']) {
+                    if (!res.hooks[hookName]) {
+                        res.hooks[hookName] = {};
+                    }
+                    if (!res.hooks[hookName].beforeSave) {
+                        res.hooks[hookName].beforeSave = [];
+                    }
+                    if (!Array.isArray(res.hooks[hookName].beforeSave)) {
+                        res.hooks[hookName].beforeSave = [res.hooks[hookName].beforeSave];
+                    }
+                    if (!res.hooks[hookName].afterSave) {
+                        res.hooks[hookName].afterSave = [];
+                    }
+                    if (!Array.isArray(res.hooks[hookName].afterSave)) {
+                        res.hooks[hookName].afterSave = [res.hooks[hookName].afterSave];
+                    }
+                }
+            });
+            if (!this.config.menu) {
+                errors.push('No config.menu defined');
+            }
+            // check if there is only one homepage: true in menu, recursivly
+            let homepages = 0;
+            const browseMenu = (menu) => {
+                menu.forEach((item) => {
+                    if (item.component && item.resourceId) {
+                        errors.push(`Menu item cannot have both component and resourceId: ${JSON.stringify(item)}`);
+                    }
+                    if (item.component && !item.path) {
+                        errors.push(`Menu item with component must have path : ${JSON.stringify(item)}`);
+                    }
+                    if (item.type === 'resource' && !item.resourceId) {
+                        errors.push(`Menu item with type 'resource' must have resourceId : ${JSON.stringify(item)}`);
+                    }
+                    if (item.resourceId && !this.config.resources.find((res) => res.resourceId === item.resourceId)) {
+                        errors.push(`Menu item with type 'resourceId' has resourceId which is not in resources: ${JSON.stringify(item)}`);
+                    }
+                    if (item.type === 'component' && !item.component) {
+                        errors.push(`Menu item with type 'component' must have component : ${JSON.stringify(item)}`);
+                    }
+                    // make sure component starts with @@
+                    if (item.component) {
+                        if (!item.component.startsWith('@@')) {
+                            errors.push(`Menu item component must start with @@ : ${JSON.stringify(item)}`);
+                        }
+                        const path = item.component.replace('@@', this.config.customization.customComponentsDir);
+                        if (!fs.existsSync(path)) {
+                            errors.push(`Menu item component "${item.component.replace('@@', '')}" does not exist in "${this.config.customization.customComponentsDir}"`);
+                        }
+                    }
+                    if (item.homepage) {
+                        homepages++;
+                        if (homepages > 1) {
+                            errors.push('There must be only one homepage: true in menu, found second one in ' + JSON.stringify(item));
+                        }
+                    }
+                    if (item.children) {
+                        browseMenu(item.children);
+                    }
+                });
+            };
+            browseMenu(this.config.menu);
+        }
+        // check for duplicate resourceIds and show which ones are duplicated
+        const resourceIds = this.config.resources.map((res) => res.resourceId);
+        const uniqueResourceIds = new Set(resourceIds);
+        if (uniqueResourceIds.size != resourceIds.length) {
+            const duplicates = resourceIds.filter((item, index) => resourceIds.indexOf(item) != index);
+            errors.push(`Duplicate fields "resourceId" or "table": ${duplicates.join(', ')}`);
+        }
+        //add ids for onSelectedAllActions for each resource
+        if (errors.length > 0) {
+            throw new Error(`Invalid AdminForth config: ${errors.join(', ')}`);
+        }
+        // check is all custom components files exists
+        for (const resource of this.config.resources) {
+            for (const column of resource.columns) {
+                if (column.components) {
+                    for (const [key, comp] of Object.entries(column.components)) {
+                        let ignoreExistsCheck = false;
+                        if (this.adminforth.codeInjector.allComponentNames[comp.file]) {
+                            // not obvious, but if we are in this if, it means that this is plugin component
+                            // and there is no sense to check if it exists in users folder
+                            ignoreExistsCheck = true;
+                        }
+                        column.components[key] = this.validateComponent(comp, errors, ignoreExistsCheck);
+                    }
+                }
+            }
+        }
+    }
+    postProcessAfterDiscover(resource) {
+        resource.columns.forEach((column) => {
+            // if db/user says column is required in boolean, expand
+            if (typeof column.required === 'boolean') {
+                column.required = { create: column.required, edit: column.required };
+            }
+            if (!column.required) {
+                column.required = { create: false, edit: false };
+            }
+            // same for editingNote
+            if (typeof column.editingNote === 'string') {
+                column.editingNote = { create: column.editingNote, edit: column.editingNote };
+            }
+        });
+        resource.dataSourceColumns = resource.columns.filter((col) => !col.virtual);
+    }
+}