index.ts

import {DollarSign, Options} from "./types";
import ControllerClass from "./src/Classes/ControllerClass";
import XpresserRepl from "./src/XpresserRepl";
import XpresserRouter from "@xpresser/router";
import InXpresserError from "./src/Errors/InXpresserError";

// Xpresser Instance Holder
const instanceHolder: Record<string, any> = {};


/**
 * Get Xpresser Instance.
 *
 * if instanceId is not defined the first getInstance will be returned;
 * @param instanceId
 */
function getInstance(instanceId?: string): DollarSign {
    if (instanceId) {
        if (instanceId === ':keys') return Object.keys(instanceHolder) as any;
        if (instanceId === ':id') return require('./truth')?.instanceId;

        if (!instanceHolder.hasOwnProperty(instanceId))
            throw new InXpresserError(`Xpresser instanceId: ${instanceId} not found!`);

        return instanceHolder[instanceId];
    } else {

        // If $ is defined then return.
        if (global.hasOwnProperty('$')) {
            // @ts-ignore
            return global.$;
        }

        const truth = require("./truth");

        if (truth && truth.instanceId) {
            return instanceHolder[truth.instanceId];
        }

        const instances = Object.keys(instanceHolder);
        if (!instances.length)
            throw new InXpresserError(`No Xpresser instance defined found!`);

        return instanceHolder[instances[0]];
    }
}


/**
 * Get Xpresser Instance Router.
 * @param instanceId
 * @returns {XpresserRouter}
 */
function getInstanceRouter(instanceId?: string): XpresserRouter {
    return getInstance(instanceId).router;
}


/**
 * Initialize Xpresser;
 * @param AppConfig
 * @param {Options} AppOptions
 * @constructor
 */
function init(AppConfig: Record<string, any> | string, AppOptions: Options = {}): DollarSign {
    // Expose xpresserInstance as global function
    // @ts-ignore
    if (!global.xpresserInstance) global.xpresserInstance = getInstance;
    // @ts-ignore
    if (!global.InXpresserError) global.InXpresserError = InXpresserError;

    /**
     * Require Modules only when this function is called.
     * This is to avoid requiring un-needed packages when ever we run
     * const {getInstance} = require('xpresser')
     */
    const fs = require("fs");
    const chalk = require("chalk");
    const XpresserRouter = require("@xpresser/router");
    // Import default config.
    const {Config, Options} = require("./config");
    const ObjectCollection = require("object-collection");
    const {randomStr} = require('./src/Functions/inbuilt.fn')
    const lodash = require("lodash");
    const truth = require("./truth");


    /**
     * Importing Package.json
     *
     * Since typescript is bundled in `dist` folder
     * package.json will be in the parent directory
     */
    let PackageDotJson: any = {};

    try {
        PackageDotJson = require("./package.json");
    } catch (e) {
        PackageDotJson = require("../package.json");
    }

    if (AppConfig === undefined) {
        AppConfig = {};
    }

    if (AppOptions === undefined) {
        AppOptions = {};
    }

    // Set Instance id to random string if not defined
    if (!AppOptions['instanceId']) truth.instanceId = AppOptions['instanceId'] = randomStr(10);

    // Set DollarSign Global Var: $
    const $ = instanceHolder[AppOptions['instanceId'] as string] = {} as DollarSign;

    $.exit = (...args) => {
        return process.exit(...args);
    };

    if (typeof AppConfig === "string") {
        const configFile = AppConfig;
        AppConfig = {} as Record<string, any>;

        if (fs.existsSync(configFile)) {

            try {
                AppConfig = require(configFile);
                // tslint:disable-next-line:max-line-length
                if (typeof AppConfig !== "object" || (typeof AppConfig === "object" && !Object.keys(AppConfig).length)) {
                    // noinspection ExceptionCaughtLocallyJS
                    throw new InXpresserError(`CONFIG: No exported object found in config file: (${configFile})`);
                }
            } catch (e) {
                console.error((e as InXpresserError).stack);
                $.exit();
            }

        } else {

            console.error("Config file not found!");
            $.exit();

        }
    }

    AppConfig = AppConfig as Record<string, any>;
    /**
     * Check if config {paths.base} exists in user defined config.
     */
    const noBaseFolderDefinedError = `No base folder defined in config {paths.base}`;
    if (!AppConfig.hasOwnProperty('paths')) {
        console.log(noBaseFolderDefinedError);
        $.exit()
    } else {
        // @ts-ignore
        if (!AppConfig['paths'].hasOwnProperty('base')) {
            console.log(noBaseFolderDefinedError);
            $.exit()
        }
    }

    /**
     * Check if env exist in config
     */
    if (!AppConfig.hasOwnProperty('env') || !AppConfig.env) {
        console.log(`Config {env} is missing, options: (development | production | others)`)
        $.exit();
    }

    if (typeof AppConfig.env !== "string") {
        console.log(`Config {env} must be of type string!`)
        $.exit();
    }

    // Merge Config with DefaultConfig to replace missing values.
    AppConfig = lodash.merge(lodash.clone(Config), AppConfig) as Record<string, any>;
    AppOptions = lodash.merge(lodash.clone(Options), AppOptions) as Options;


    // Initialize {$.on} for the first time.
    // @ts-ignore
    $.on = {};

    // Set {$.objectCollection}
    if (typeof AppConfig['ObjectCollection'] === "function") {
        const OwnObjectCollection: any = AppConfig.ObjectCollection()
        $.objectCollection = (obj?) => new OwnObjectCollection(obj) as typeof ObjectCollection;
    } else {
        $.objectCollection = (obj?) => new ObjectCollection(obj);
    }


    // Expose {$}(DollarSign) to globals.
    // @ts-ignore
    if (AppOptions.exposeDollarSign) global.$ = $;

    /**
     * Get Xjs Cli Config
     */
    const CliConfig: any = (global as any)["XjsCliConfig"];

    /**
     * Set Config to object-collection of AppConfig
     */
    $.config = $.objectCollection(AppConfig as object);

    /**
     * Set $.options
     * @type Options
     */
    $.options = AppOptions;

    /**
     * Engine Data serves as the store
     * for all data stored by Xpresser files/components
     */
    $.engineData = $.objectCollection({});

    /**
     * Store serves as the store
     * for the application
     */
    $.store = $.objectCollection({});

    const LaunchType = process.argv[2];
    $.engineData.set("LaunchType", LaunchType);

    if (typeof CliConfig !== "undefined" || LaunchType === "cli") {
        $.options.isConsole = true;
    }

    // Set $.isTypeScript
    $.isTypescript = () => {
        return $.config.get('project.fileExtension') === ".ts";
    }


    $.isNativeCliCommand = () => {
        return LaunchType === "cli" &&
            (process.argv[3] &&
                process.argv[3].slice(0, 5) === "make:") as boolean
    }


    // Set Engine Path
    const enginePath = $.config.get('paths.engine');
    if (!enginePath) {
        let dirName = __dirname;

        /**
         * Check if xpresser dist folder if being used
         * "\\ is for windows"
         */
        if (["/dist", "\\dist"].includes(dirName.slice(-5))) {
            dirName = dirName.slice(0, dirName.length - 5)
        }

        $.config.set('paths.engine', `${dirName}/src/`);
    }

    /* ------------- $.on Events Loader ------------- */
    require("./src/On");
    // Require $.file
    require("./src/FileEngine");
    // Include Loggers
    require("./src/Extensions/Loggers");
    // Include If extensions
    require("./src/Extensions/If");

    // Log if not console
    $.ifNotConsole(() => {
        $.logCalmly(`${PackageDotJson.name} version ${PackageDotJson.version}`);
        let {name, env}: { name: string, env: string } = $.config.all();
        if (env) {
            env = lodash.startCase(env);
            env = env.toLowerCase() === "development" ? chalk.yellow(`(${env})`) : chalk.greenBright(`(${env})`);
            env = chalk.yellow(env);
        }
        $.log(`${name} ${env}`.trim());
    });

    /**
     * Change timezone if timezone is defined.
     */
    const timezone: string | undefined = $.config.get('date.timezone');
    if (timezone) {
        process.env.TZ = timezone;
    }

    // Include PathHelper Extensions
    require("./src/Extensions/Path");

    // Require Global
    require("./src/global");

    // Get OnEvents Loader.
    const {runBootEvent} = require("./src/Events/OnEventsLoader");

    async function afterStartEvents() {
        // Require Plugin Engine and load plugins
        const PluginEngine = require("./src/PluginEngine");
        const PluginData = await PluginEngine.loadPlugins(PackageDotJson);

        $.engineData.set("PluginEngineData", PluginData);

        /**
         * Load `use.json`
         * This is after plugins have loaded
         */
        const useDotJson = $.objectCollection();
        const useDotJsonPath = $.path.jsonConfigs("use.json");

        if ($.file.exists(useDotJsonPath)) {
            // Import Use.json
            useDotJson.merge(require(useDotJsonPath));
            // Save to EngineData
            $.engineData.set("UseDotJson", useDotJson);
        }

        /**
         * @type {UseEngine}
         */
        $.use = require("./src/UseEngine");

        /**
         * Add Router
         * @type {XpresserRouter}
         */
        $.router = new XpresserRouter(undefined, () => $);

        $.ifNotConsole(() => {
            /**
             * Load Registered Events
             */
            require("./src/Events/Loader");
        });
    }

    $.boot = () => {
        // Prevents `$.boot()` booting twice
        if ($.engineData.has('hasBooted'))
            return false;

        // Set HasBooted in engine data
        $.engineData.set('hasBooted', true);

        /**
         * Load on.start Events
         */
        return runBootEvent("start", () => {
            afterStartEvents().then(() => {
                /**
                 * Load on.boot Events
                 */
                runBootEvent("boot", () => {
                    /**
                     * AppOptions.require_only
                     * This config is only used by xpresser cron.
                     * Used to load your main file without booting it
                     */
                    if (!$.options.requireOnly) {
                        $.ifConsole(() => {
                            require("./src/StartConsole");
                        }, () => {
                            require("./src/StartHttp");
                        });
                    }
                });
            }).catch(e => {
                $.logError(e);
                $.logErrorAndExit('Error in $.on.boot events');
            })
        });
    };

    /**
     * Boot if $.options.autoBoot is true.
     */
    if ($.options.autoBoot === true) {
        $.boot();
    }

    return $;
}

export {init, getInstance, getInstanceRouter, ControllerClass, XpresserRepl, InXpresserError}