@adaptivestone/framework 5.0.0-beta.11 → 5.0.0-beta.13

package/dist/modules/Base.d.ts

@@ -0,0 +1,29 @@
+import type { IApp } from '../server.ts';
+import type winston from 'winston';
+declare class Base {
+    #private;
+    app: IApp;
+    constructor(app: IApp);
+    /**
+     * In case of logging sometimes we might need to replace name
+     */
+    getConstructorName(): string;
+    /**
+     * Optimzation to lazy load logger. It will be inited only on request
+     */
+    get logger(): winston.Logger | null;
+    /**
+     * Get winston loger for given label
+     * @param {string} label name of logger
+     */
+    getLogger(label: string): winston.Logger;
+    getFilesPathWithInheritance(internalFolder: string, externalFolder: string): Promise<{
+        path: string;
+        file: string;
+    }[]>;
+    /**
+     * Return logger group. Just to have all logs groupped logically
+     */
+    static get loggerGroup(): string;
+}
+export default Base;

package/dist/modules/Base.js

@@ -0,0 +1,54 @@
+import { getFilesPathWithInheritance } from "../helpers/files.js";
+class Base {
+    #realLogger = null;
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * In case of logging sometimes we might need to replace name
+     */
+    getConstructorName() {
+        return this.constructor.name;
+    }
+    /**
+     * Optimzation to lazy load logger. It will be inited only on request
+     */
+    get logger() {
+        let l;
+        try {
+            l = this.#realLogger;
+        }
+        catch {
+            console.warn(`You try to accees logger not from class. that can be ok in case of models.`);
+            return null;
+        }
+        if (!l) {
+            const { loggerGroup } = this.constructor;
+            this.#realLogger = this.getLogger(loggerGroup + this.getConstructorName());
+        }
+        return this.#realLogger;
+    }
+    /**
+     * Get winston loger for given label
+     * @param {string} label name of logger
+     */
+    getLogger(label) {
+        return this.app.logger.child({ label });
+    }
+    async getFilesPathWithInheritance(internalFolder, externalFolder) {
+        return getFilesPathWithInheritance({
+            internalFolder,
+            externalFolder,
+            logger: (text) => this.logger?.verbose(text),
+        });
+    }
+    /**
+     * Return logger group. Just to have all logs groupped logically
+     */
+    static get loggerGroup() {
+        return 'Base_please_overwrite_';
+    }
+}
+export default Base;
+//# sourceMappingURL=Base.js.map

package/dist/modules/Base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.js","sourceRoot":"","sources":["../../src/modules/Base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAIlE,MAAM,IAAI;IACR,WAAW,GAA0B,IAAI,CAAC;IAE1C,GAAG,CAAO;IAEV,YAAY,GAAS;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,CAAC;QACN,IAAI,CAAC;YACH,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,IAAI,CACV,4EAA4E,CAC7E,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,CAAC,EAAE,CAAC;YACP,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,WAA0B,CAAC;YACxD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAC/B,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CACxC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,2BAA2B,CAC/B,cAAsB,EACtB,cAAsB;QAEtB,OAAO,2BAA2B,CAAC;YACjC,cAAc;YACd,cAAc;YACd,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,KAAK,WAAW;QACpB,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}

package/dist/modules/BaseCli.d.ts

@@ -0,0 +1,25 @@
+import Base from './Base.ts';
+import type Server from '../server.ts';
+import type { ParseArgsOptionDescriptor } from 'node:util';
+import type AbstractCommand from '../modules/AbstractCommand.ts';
+export interface ParseArgsOptionsConfigExtended extends ParseArgsOptionDescriptor {
+    /**
+     * A description of the option.
+     */
+    description?: string;
+    /**
+     * Is it required?
+     */
+    required?: boolean;
+}
+declare class Cli extends Base {
+    server: Server;
+    commands: Record<string, string>;
+    constructor(server: Server);
+    loadCommands(): Promise<boolean>;
+    printCommandTable(): Promise<void>;
+    static showHelp(Command: typeof AbstractCommand, finalArguments: Record<string, ParseArgsOptionsConfigExtended>): void;
+    run(command: string): Promise<boolean | void>;
+    static get loggerGroup(): string;
+}
+export default Cli;

package/dist/modules/BaseCli.js

@@ -0,0 +1,138 @@
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import path from 'node:path';
+import * as url from 'node:url';
+import { parseArgs } from 'node:util';
+import Base from "./Base.js";
+class Cli extends Base {
+    server;
+    commands;
+    constructor(server) {
+        super(server.app);
+        this.server = server;
+        this.commands = {};
+    }
+    async loadCommands() {
+        if (Object.keys(this.commands).length) {
+            return true;
+        }
+        const dirname = url.fileURLToPath(new URL('.', import.meta.url));
+        const commandsToLoad = await this.getFilesPathWithInheritance(path.join(dirname, '../commands'), this.server.app.foldersConfig.commands);
+        for (const com of commandsToLoad) {
+            if (com.file.endsWith('.js') || com.file.endsWith('.ts')) {
+                const c = com.file.replace('.js', '').replace('.ts', '');
+                if (this.commands[c.toLowerCase()]) {
+                    this.logger?.warn(`Command ${c.toLowerCase()} already exists with full path ${this.commands[c.toLowerCase()]}. Possible problems - you have two commands with "ts" and "js" extensions. Skipping...`);
+                    continue;
+                }
+                this.commands[c.toLowerCase()] = com.path;
+            }
+        }
+        return true;
+    }
+    async printCommandTable() {
+        const commands = Object.keys(this.commands).sort();
+        const maxLength = commands.reduce((max, c) => Math.max(max, c.length), 0);
+        console.log('Available commands:');
+        const commandsClasses = [];
+        for (const c of commands) {
+            commandsClasses.push(import(__rewriteRelativeImportExtension(this.commands[c])));
+            // console.log(
+            //   ` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${f.default.description}`,
+            // );
+        }
+        const commandsClassesLoaded = await Promise.all(commandsClasses);
+        for (const [key, c] of Object.entries(commands)) {
+            console.log(` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${commandsClassesLoaded[+key].default.description}`);
+        }
+        console.log('\nUsage (use one of option): \n node cli.ts <command> [options] \n npm run cli <command>  -- [options]');
+    }
+    static showHelp(Command, finalArguments) {
+        console.log(`\n\x1b[32m${Command.description}\x1b[0m`);
+        let output = '';
+        Object.entries(finalArguments).forEach(([key, opt]) => {
+            const outputLocal = [];
+            outputLocal.push(`\n\x1b[36m  --${key} \x1b[0m`);
+            if (opt.type !== 'boolean') {
+                outputLocal.push(`<${opt.type}>`);
+                // flag += `<${opt.type}>`;
+            }
+            if (opt.required) {
+                outputLocal.push('(required)');
+            }
+            outputLocal.push(`\n      \x1b[2m${opt.description}`);
+            if (opt.default !== undefined) {
+                outputLocal.push(` (default: ${opt.default})`);
+            }
+            outputLocal.push('\x1b[0m');
+            output += outputLocal.join(' ');
+        });
+        console.log(output);
+    }
+    async run(command) {
+        await this.loadCommands();
+        if (!command) {
+            console.log('Please provide command name');
+            await this.printCommandTable();
+            return false;
+        }
+        if (!this.commands[command]) {
+            console.log(`Command ${command} not found `);
+            await this.printCommandTable();
+            return false;
+        }
+        const commandModule = await import(__rewriteRelativeImportExtension(this.commands[command]));
+        const Command = commandModule.default;
+        const defaultArgs = {
+            help: {
+                type: 'boolean',
+                description: 'Show help',
+            },
+        };
+        const finalArguments = {
+            ...Command.commandArguments,
+            ...defaultArgs,
+        };
+        const parsedArgs = parseArgs({
+            args: process.argv.slice(3), // remove command name
+            options: finalArguments,
+            tokens: true,
+        });
+        if (parsedArgs.values.help) {
+            Cli.showHelp(Command, finalArguments);
+            return true;
+        }
+        for (const [key, opt] of Object.entries(finalArguments)) {
+            if (opt.required && !parsedArgs.values[key]) {
+                console.log(`\x1b[31mRequired field not proivded. Please provide "${key}" argument\x1b[0m`);
+                Cli.showHelp(Command, finalArguments);
+                return false;
+            }
+        }
+        if (Command.isShouldInitModels) {
+            this.logger?.debug(`Command ${command} isShouldInitModels called. If you want to skip loading and init models, please set isShouldInitModels to false in tyou command`);
+            process.env.MONGO_APP_NAME = Command.getMongoConnectionName(command, parsedArgs.values);
+            await this.server.initAllModels();
+        }
+        else {
+            this.logger?.debug(`Command ${command} NOT need to isShouldInitModels`);
+        }
+        const c = new Command(this.app, this.commands, parsedArgs.values);
+        let result;
+        result = await c.run().catch((e) => {
+            this.logger?.error(e.stack);
+        });
+        return result;
+    }
+    static get loggerGroup() {
+        return 'CLI_';
+    }
+}
+export default Cli;
+//# sourceMappingURL=BaseCli.js.map

package/dist/modules/BaseCli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseCli.js","sourceRoot":"","sources":["../../src/modules/BaseCli.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,IAAI,MAAM,WAAW,CAAC;AAkB7B,MAAM,GAAI,SAAQ,IAAI;IACpB,MAAM,CAAS;IACf,QAAQ,CAAyB;IAEjC,YAAY,MAAc;QACxB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAC3D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,EACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CACvC,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;YACjC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzD,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACzD,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;oBACnC,IAAI,CAAC,MAAM,EAAE,IAAI,CACf,WAAW,CAAC,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,wFAAwF,CACnL,CAAC;oBACF,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACnD,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1E,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,eAAe,CAAC,IAAI,CAAC,MAAM,kCAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC;YAC/C,eAAe;YACf,yEAAyE;YACzE,KAAK;QACP,CAAC;QACD,MAAM,qBAAqB,GAEvB,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QACvC,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChD,OAAO,CAAC,GAAG,CACT,YAAY,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAC9F,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,GAAG,CACT,wGAAwG,CACzG,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,OAA+B,EAC/B,cAA8D;QAE9D,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,CAAC,WAAW,SAAS,CAAC,CAAC;QACvD,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YACpD,MAAM,WAAW,GAAG,EAAE,CAAC;YACvB,WAAW,CAAC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,CAAC;YACjD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;gBAClC,2BAA2B;YAC7B,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACjB,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,kBAAkB,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACtD,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC9B,WAAW,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC;YACjD,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;YAC3C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,aAAa,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,aAAa,GAAwC,MAAM,MAAM,kCACrE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EACvB,CAAC;QACF,MAAM,OAAO,GAA2B,aAAa,CAAC,OAAO,CAAC;QAE9D,MAAM,WAAW,GAAmD;YAClE,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,WAAW;aACzB;SACF,CAAC;QAEF,MAAM,cAAc,GAAG;YACrB,GAAG,OAAO,CAAC,gBAAgB;YAC3B,GAAG,WAAW;SACf,CAAC;QAEF,MAAM,UAAU,GAAG,SAAS,CAAC;YAC3B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,sBAAsB;YACnD,OAAO,EAAE,cAAc;YACvB,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACxD,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5C,OAAO,CAAC,GAAG,CACT,wDAAwD,GAAG,mBAAmB,CAC/E,CAAC;gBACF,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBACtC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,WAAW,OAAO,iIAAiI,CACpJ,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,sBAAsB,CACzD,OAAO,EACP,UAAU,CAAC,MAAM,CAClB,CAAC;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,OAAO,iCAAiC,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAClE,IAAI,MAAM,CAAC;QAEX,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAiB,EAAE,EAAE;YACjD,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,eAAe,GAAG,CAAC"}

package/dist/server.d.ts

@@ -0,0 +1,110 @@
+import EventEmitter from 'node:events';
+import winston from 'winston';
+import Cache from './services/cache/Cache.ts';
+import type { TFolderConfig, TFolderConfigFolders } from './folderConfig.ts';
+import type BaseCli from './modules/BaseCli.ts';
+import type HttpServer from './services/http/HttpServer.ts';
+import type ControllerManager from './controllers/index.ts';
+import type AbstractModel from './modules/AbstractModel.ts';
+interface IApp {
+    getConfig: (configName: string) => Record<string, any>;
+    getModel: (modelName: string) => AbstractModel['mongooseModel'] | false | any;
+    runCliCommand: (commandName: string) => Promise<boolean | void>;
+    updateConfig: (configName: string, config: {}) => Record<string, any>;
+    foldersConfig: TFolderConfigFolders;
+    events: EventEmitter<[never]>;
+    readonly cache: Cache;
+    readonly logger: winston.Logger;
+    httpServer: null | HttpServer;
+    controllerManager: null | ControllerManager;
+    frameworkFolder: string;
+    documentation?: any[];
+}
+/**
+ * Main framework class.
+ */
+declare class Server {
+    #private;
+    cli: null | BaseCli;
+    config: TFolderConfig;
+    cache: {
+        configs: Map<any, any>;
+        models: Map<any, any>;
+        modelConstructors: Map<any, any>;
+    };
+    cacheService: null | Cache;
+    app: IApp;
+    /**
+     * Construct new server
+     * @param {Object} config main config object
+     * @param {Object} config.folders folders config
+     * @param {String} config.folders.config path to folder with config files
+     * @param {String} config.folders.models path to folder with moidels files
+     * @param {String} config.folders.controllers path to folder with controllers files
+     * @param {String} config.folders.locales path to folder with locales files
+     * @param {String} [config.folders.emails] path to folder with emails files
+     * @param {String} config.folders.commands path to folder with commands files
+     * @param {String} config.folders.migrations path to folder with migrations files
+     */
+    constructor(config: TFolderConfig);
+    /**
+     * Start server (http  + init all http ralated functions)
+     * @param {Function} callbackBefore404 code that should be executed before adding page 404
+     */
+    startServer(callbackBefore404?: () => Promise<void>): Promise<void>;
+    /**
+     * Do an initialization (config reading,  etc)
+     */
+    init({ isSkipModelInit, isSkipModelLoading, }?: {
+        isSkipModelInit?: boolean | undefined;
+        isSkipModelLoading?: boolean | undefined;
+    }): Promise<boolean>;
+    /**
+     * Load model and init them
+     */
+    initAllModels(): Promise<void>;
+    /**
+     * Add error logging on promise reject
+     */
+    addErrorHandling(): void;
+    /**
+     * Return config from {configName} (file name) on config folder.
+     * Support cache and updating confing into cache
+     * Also will update config based on NODE_ENV. If config.js and config.production.js
+     * and NODE_ENV is production then we will load base config (config.js) and the load
+     * environment config (config.production.js) and overwrite base config options
+     * @see updateConfig
+     * @param {String} configName name on config file to load
+     * @returns {Object} config object. Structure depends of config file
+     */
+    getConfig(configName: string): Record<string, any>;
+    /**
+     * Return or create new logger instance. This is a main logger instance
+     */
+    getLogger(): winston.Logger;
+    /**
+     * Primary designed for tests when we need to update some configs before start testing
+     * Should be called before any initialization was done
+     * @TODO send event to all inited components to update config
+     * @param {String} configName
+     * @param {Object} config
+     */
+    updateConfig(configName: string, config: Record<string, any>): Record<string, any>;
+    /**
+     * Return model from {modelName} (file name) on model folder.
+     * Support cache
+     * @param {String} modelName name on config file to load
+     */
+    getModel(modelName: string): AbstractModel['mongooseModel'] | false;
+    /**
+     * Run cli command into framework (http, ws, etc)
+     * @param {String} commandName name of command to load
+     */
+    runCliCommand(commandName: string): Promise<boolean | void>;
+    /**
+     * Get internal cache service
+     */
+    getCache(): Cache;
+}
+export default Server;
+export { type IApp };