mockapi-msi 2.0.1 → 2.5.0

package/modules/HttpException.js

@@ -1,31 +1,9 @@
-function HttpException(httpStatusCode, message) {
-    var instance = new Error(message);
-    
-    instance.name = 'HttpException';
-    instance.httpStatusCode = httpStatusCode;
-    
-    Object.setPrototypeOf(instance, Object.getPrototypeOf(this));
-    
-    if (Error.captureStackTrace) {
-        Error.captureStackTrace(instance, HttpException);
-    }
-
-    return instance;
-  }
-  
-  HttpException.prototype = Object.create(Error.prototype, {
-    constructor: {
-        value: Error,
-        enumerable: false,
-        writable: true,
-        configurable: true
-    }
-});
-  
-if (Object.setPrototypeOf){
-    Object.setPrototypeOf(HttpException, Error);
-} else {
-    HttpException.__proto__ = Error;
-}
-
+class HttpException extends Error {
+    constructor(httpStatusCode, message) {
+        super(message);
+        this.name = 'HttpException';
+        this.httpStatusCode = httpStatusCode;
+    }
+}
+
 module.exports = HttpException;

package/modules/banner.js

@@ -0,0 +1,22 @@
+const constants = require('./constants');
+
+const { fgCyan, fgGreen, fgYellow, fgMagenta, reset } = constants.COLOR;
+
+
+const banner = [
+    `${fgCyan}$$\\      $$\\                     $$\\        $$$$$$\\  $$$$$$$\\ $$$$$$\\ ${reset}`,
+    `${fgCyan}$$$\\    $$$ |                    $$ |      $$  __$$\\ $$  __$$\\\\_$$  _|${reset}`,
+    `${fgCyan}$$$$\\  $$$$ | $$$$$$\\   $$$$$$$\\ $$ |  $$\\ $$ /  $$ |$$ |  $$ | $$ |  ${reset}`,
+    `${fgGreen}$$\\$$\\$$ $$ |$$  __$$\\ $$  _____|$$ | $$  |$$$$$$$$ |$$$$$$$  | $$ |  ${reset}`,
+    `${fgGreen}$$ \\$$$  $$ |$$ /  $$ |$$ /      $$$$$$  / $$  __$$ |$$  ____/  $$ |  ${reset}`,
+    `${fgGreen}$$ |\\$  /$$ |$$ |  $$ |$$ |      $$  _$$<  $$ |  $$ |$$ |       $$ |  ${reset}`,
+    `${fgMagenta}$$ | \\_/ $$ |\\$$$$$$  |\\$$$$$$$\\ $$ | \\$$\\ $$ |  $$ |$$ |     $$$$$$\\ ${reset}`,
+    `${fgMagenta}\\__|     \\__| \\______/  \\_______|\\__|  \\__|\\__|  \\__|\\__|     \\______|${reset}`,
+];
+
+const display = () => {
+    banner.forEach(line => console.log(line));
+    console.log('');
+};
+
+module.exports = { display };

package/modules/cli.js

@@ -1,107 +1,110 @@
-const readline = require('readline');
-const YAML = require('yaml');
-const fs = require('fs');
-
-class CLI {
-
-    _configurationFilePath = "";
-    _arguments = [];
-    _commands = {
-        "--help": this._helpCommand,
-        "help": this._helpCommand,
-        "init": this._initCommand,
-        "--init": this._initCommand
-    };
-    _configTemplate = {
-        port: 8080,
-        enableCors: true,
-        data: {
-          myRows: { path: 'YOUR FOLDER', reader: 'folder' }
-        },
-        endpoints: {
-          '/data': {
-            verb: 'get',
-            data: 'myRows',
-            responseStatus: 200,
-            responseContentType: 'application/json'
-          }
-        },
-        log: 'verbose'
-    };
-
-    constructor(configurationFilePath) {
-        this._configurationFilePath = configurationFilePath;
-        this._arguments = process.argv.slice(2);
-    }
-
-    _initCommand() {
-        let configTemplate = this._configTemplate;
-
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout
-        });
-
-        console.log("Creating a basic configuration file");
-        console.log("");
-
-        rl.question(`Set MockAPI listening port (8080): `, (port) => {
-            rl.question(`Do you want to enable CORS? Y/n: `, (enableCors) => {
-                rl.question(`Do you want to include default endpoint? Y/n: `, (defaultEndpoint) => {
-                    const configPort = port || 8080;
-                    const configEnableCors = enableCors === "Y" || enableCors === "y" || enableCors === "";
-                    const configDefaultEndpoint = defaultEndpoint === "Y" || defaultEndpoint === "y" || defaultEndpoint === "";
-
-                    configTemplate.port = configPort;
-                    configTemplate.enableCors = configEnableCors;
-
-                    if (configDefaultEndpoint === false) {
-                        delete configTemplate.endpoints;
-                        delete configTemplate.data;
-                    }
-
-                    const configFile = YAML.stringify(configTemplate);
-
-                    fs.writeFile(this._configurationFilePath, configFile, (err) => {
-                        if (err) {
-                            console.log(err);
-                        } else {
-                            console.log("Configuration file created");
-                        }
-                    });
-                    
-                    rl.close();
-                });
-            });        
-        });
-
-    }
-
-    _helpCommand() {
-        console.log("Run MockAPI:");
-        console.log("mockapi\n");
-        console.log("Command execution:\n");
-        console.log("mockapi <command>");
-        console.log("");
-        console.log("--help, help    shows this help");
-        console.log("--init, init    creates a basic configuration file");
-        console.log("");
-    }
-
-    hasCommands() { return this._arguments.length > 0; }
-
-    executeCommandLine() {
-        if (this._arguments.length > 0) {
-
-            let command = this._commands["--help"];
-
-            if (this._commands[this._arguments[0]] !== undefined) {
-                command = this._commands[this._arguments[0]];
-            }
-
-            command.apply(this);
-        }
-    }
-}
-
-module.exports = CLI;
+const readline = require('readline');
+const YAML = require('yaml');
+const fs = require('fs');
+
+class CLI {
+
+    _configurationFilePath = "";
+    _arguments = [];
+    _commands = {
+        "--help": this._helpCommand,
+        "help": this._helpCommand,
+        "init": this._initCommand,
+        "--init": this._initCommand
+    };
+    _configTemplate = {
+        port: 8080,
+        enableCors: true,
+        openApi: {
+          enabled: true
+        },
+        data: {
+          myRows: { path: 'YOUR FOLDER', reader: 'folder' }
+        },
+        endpoints: {
+          '/data': {
+            verb: 'get',
+            data: 'myRows',
+            responseStatus: 200,
+            responseContentType: 'application/json'
+          }
+        },
+        log: 'verbose'
+    };
+
+    constructor(configurationFilePath) {
+        this._configurationFilePath = configurationFilePath;
+        this._arguments = process.argv.slice(2);
+    }
+
+    _initCommand() {
+        let configTemplate = this._configTemplate;
+
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+
+        console.log("Creating a basic configuration file");
+        console.log("");
+
+        rl.question(`Set MockAPI listening port (8080): `, (port) => {
+            rl.question(`Do you want to enable CORS? Y/n: `, (enableCors) => {
+                rl.question(`Do you want to include default endpoint? Y/n: `, (defaultEndpoint) => {
+                    const configPort = port || 8080;
+                    const configEnableCors = enableCors === "Y" || enableCors === "y" || enableCors === "";
+                    const configDefaultEndpoint = defaultEndpoint === "Y" || defaultEndpoint === "y" || defaultEndpoint === "";
+
+                    configTemplate.port = configPort;
+                    configTemplate.enableCors = configEnableCors;
+
+                    if (configDefaultEndpoint === false) {
+                        delete configTemplate.endpoints;
+                        delete configTemplate.data;
+                    }
+
+                    const configFile = YAML.stringify(configTemplate);
+
+                    fs.writeFile(this._configurationFilePath, configFile, (err) => {
+                        if (err) {
+                            console.log(err);
+                        } else {
+                            console.log("Configuration file created");
+                        }
+                    });
+                    
+                    rl.close();
+                });
+            });        
+        });
+
+    }
+
+    _helpCommand() {
+        console.log("Run MockAPI:");
+        console.log("mockapi\n");
+        console.log("Command execution:\n");
+        console.log("mockapi <command>");
+        console.log("");
+        console.log("--help, help    shows this help");
+        console.log("--init, init    creates a basic configuration file");
+        console.log("");
+    }
+
+    hasCommands() { return this._arguments.length > 0; }
+
+    executeCommandLine() {
+        if (this._arguments.length > 0) {
+
+            let command = this._commands["--help"];
+
+            if (this._commands[this._arguments[0]] !== undefined) {
+                command = this._commands[this._arguments[0]];
+            }
+
+            command.apply(this);
+        }
+    }
+}
+
+module.exports = CLI;

package/modules/configWatcher.js

@@ -0,0 +1,60 @@
+const fs = require('fs');
+const YAML = require('yaml');
+const readers = require('./readers');
+
+class ConfigWatcher {
+
+    _filePath = '';
+    _logger = null;
+    _onChange = null;
+    _watcher = null;
+    _debounceTimer = null;
+
+    constructor(filePath, logger, onChange) {
+        this._filePath = filePath;
+        this._logger = logger;
+        this._onChange = onChange;
+    }
+
+    watch() {
+        this._logger.info(`Watching configuration file for changes: ${this._filePath}`);
+
+        this._watcher = fs.watch(this._filePath, (eventType) => {
+            if (eventType !== 'change') return;
+
+            // Debounce rapid file system events
+            clearTimeout(this._debounceTimer);
+            this._debounceTimer = setTimeout(() => {
+                this._reload();
+            }, 300);
+        });
+    }
+
+    _reload() {
+        try {
+            const configFile = readers.text_reader(this._filePath);
+            const parsedConfiguration = YAML.parse(configFile());
+
+            if (parsedConfiguration.port === undefined) {
+                this._logger.error('Hot-reload skipped: port property is required');
+                return;
+            }
+
+            this._logger.message('');
+            this._logger.info('Configuration file changed. Reloading...');
+            this._onChange(parsedConfiguration);
+        } catch (error) {
+            this._logger.error(`Hot-reload failed: ${error.message}`);
+        }
+    }
+
+    stop() {
+        if (this._watcher) {
+            this._watcher.close();
+            this._watcher = null;
+        }
+        clearTimeout(this._debounceTimer);
+    }
+}
+
+module.exports = ConfigWatcher;

package/modules/configurationParser.js

@@ -1,44 +1,44 @@
-const readers = require("./readers");
-
-const parseProperties = function (properties) {
-    let property = {
-        startIndex: 0,
-        format: "json",
-        direction: "rand"
-    };
-
-    if (properties === undefined) return property;
-
-    const props = properties;
-
-    if (props.length < 3) throw new Error("Invalid properties");
-    if (isNaN(props[2])) throw new Error("Index must be a number");
-
-    property.startIndex = parseFloat(props[2]);
-    property.format = props[0];
-    property.direction = props[1];
-
-    return property;
-}
-
-const injectHandlers = function (data) {
-
-    for (const variable in data) {
-        if (Object.hasOwnProperty.call(data, variable)) {
-            const node = data[variable];
-            
-            if (node.path === undefined) throw new Error("Node requires a path");
-            if (node.reader === undefined) throw new Error("Node requires a reader");
-            if (readers[node.reader + "_reader"] === undefined) throw new Error("Selected reader cannot be found");
-
-            const properties = parseProperties(node.properties);
-
-            const nodeHandler = readers[node.reader + "_reader"];
-            node.dataHandler = nodeHandler(node.path, properties);
-        }
-    }
-};
-
-module.exports = {
-    loadHandlersFromConfiguration: injectHandlers
+const readers = require("./readers");
+
+const parseProperties = function (properties) {
+    let property = {
+        startIndex: 0,
+        format: "json",
+        direction: "rand"
+    };
+
+    if (properties === undefined) return property;
+
+    const props = properties;
+
+    if (props.length < 3) throw new Error("Invalid properties");
+    if (isNaN(props[2])) throw new Error("Index must be a number");
+
+    property.startIndex = parseFloat(props[2]);
+    property.format = props[0];
+    property.direction = props[1];
+
+    return property;
+}
+
+const injectHandlers = function (data) {
+
+    for (const variable in data) {
+        if (Object.hasOwnProperty.call(data, variable)) {
+            const node = data[variable];
+            
+            if (node.path === undefined) throw new Error("Node requires a path");
+            if (node.reader === undefined) throw new Error("Node requires a reader");
+            if (readers[node.reader + "_reader"] === undefined) throw new Error("Selected reader cannot be found");
+
+            const properties = parseProperties(node.properties);
+
+            const nodeHandler = readers[node.reader + "_reader"];
+            node.dataHandler = nodeHandler(node.path, properties);
+        }
+    }
+};
+
+module.exports = {
+    loadHandlersFromConfiguration: injectHandlers
 }

package/modules/constants.js

@@ -1,96 +1,96 @@
-module.exports = {
-    BASE_URL: "http://localhost",
-    CONFIG_FILE_NAME: ".mockapi-config",
-    LOG_LEVELS: {
-        DEBUG: "debug",
-        ERROR: "error",
-        VERBOSE: "verbose",
-        NONE: "none"
-    },
-    EXTERNAL_MODULES_PATH: "apiHandlers/",
-    DEFAULT_CONTENT_TYPE: "text/plain",
-    HTTP_STATUS_CODES: {
-        CONTINUE                            :100,
-        SWITCHING_PROTOCOLS	                :101,
-        PROCESSING                          :102,
-        OK	                                :200,
-        CREATED                             :201,
-        ACCEPTED                            :202,
-        NON_AUTHORITATIVE_INFORMATION       :203,
-        NO_CONTENT	                        :204,
-        RESET_CONTENT                       :205,
-        PARTIAL_CONTENT                     :206,
-        MULTI_STATUS	                    :207,
-        MULTIPLE_CHOICES	                :300,
-        MOVED_PERMANENTLY	                :301,
-        MOVED_TEMPORARILY	                :302,
-        SEE_OTHER	                        :303,
-        NOT_MODIFIED	                    :304,
-        USE_PROXY	                        :305,
-        TEMPORARY_REDIRECT	                :307,
-        PERMANENT_REDIRECT	                :308,
-        BAD_REQUEST	                        :400,
-        UNAUTHORIZED	                    :401,
-        PAYMENT_REQUIRED	                :402,
-        FORBIDDEN	                        :403,
-        NOT_FOUND	                        :404,
-        METHOD_NOT_ALLOWED	                :405,
-        NOT_ACCEPTABLE	                    :406,
-        PROXY_AUTHENTICATION_REQUIRED       :407,
-        REQUEST_TIMEOUT	                    :408,
-        CONFLICT                            :409,
-        GONE	                            :410,
-        LENGTH_REQUIRED                     :411,
-        PRECONDITION_FAILED                 :412,
-        REQUEST_TOO_LONG	                :413,
-        REQUEST_URI_TOO_LONG                :414,
-        UNSUPPORTED_MEDIA_TYPE              :415,
-        REQUESTED_RANGE_NOT_SATISFIABLE     :416,
-        EXPECTATION_FAILED                  :417,
-        IM_A_TEAPOT	                        :418,
-        INSUFFICIENT_SPACE_ON_RESOURCE	    :419,
-        METHOD_FAILURE	                    :420,
-        UNPROCESSABLE_ENTITY                :422,
-        LOCKED	                            :423,
-        FAILED_DEPENDENCY                   :424,
-        PRECONDITION_REQUIRED               :428,
-        TOO_MANY_REQUESTS	                :429,
-        REQUEST_HEADER_FIELDS_TOO_LARGE     :431,
-        UNAVAILABLE_FOR_LEGAL_REASONS	    :451,
-        INTERNAL_SERVER_ERROR	            :500,
-        NOT_IMPLEMENTED	                    :501,
-        BAD_GATEWAY	                        :502,
-        SERVICE_UNAVAILABLE                 :503,
-        GATEWAY_TIMEOUT	                    :504,
-        HTTP_VERSION_NOT_SUPPORTED	        :505,
-        INSUFFICIENT_STORAGE	            :507,
-        NETWORK_AUTHENTICATION_REQUIRED     :511
-    },
-    COLOR: {
-        reset: '\x1b[0m',
-        bright: '\x1b[1m',
-        dim: '\x1b[2m',
-        underscore: '\x1b[4m',
-        blink: '\x1b[5m',
-        reverse: '\x1b[7m',
-        hidden: '\x1b[8m',
-        
-        fgBlack: '\x1b[30m',
-        fgRed: '\x1b[31m',
-        fgGreen: '\x1b[32m',
-        fgYellow: '\x1b[33m',
-        fgBlue: '\x1b[34m',
-        fgMagenta: '\x1b[35m',
-        fgCyan: '\x1b[36m',
-        fgWhite: '\x1b[37m',
-        
-        bgBlack: '\x1b[40m',
-        bgRed: '\x1b[41m',
-        bgGreen: '\x1b[42m',
-        bgYellow: '\x1b[43m',
-        bgBlue: '\x1b[44m',
-        bgMagenta: '\x1b[45m',
-        bgCyan: '\x1b[46m',
-        bgWhite: '\x1b[47m'
-    }
+module.exports = {
+    BASE_URL: "http://localhost",
+    CONFIG_FILE_NAME: ".mockapi-config",
+    LOG_LEVELS: {
+        DEBUG: "debug",
+        ERROR: "error",
+        VERBOSE: "verbose",
+        NONE: "none"
+    },
+    EXTERNAL_MODULES_PATH: "apiHandlers/",
+    DEFAULT_CONTENT_TYPE: "text/plain",
+    HTTP_STATUS_CODES: {
+        CONTINUE                            :100,
+        SWITCHING_PROTOCOLS	                :101,
+        PROCESSING                          :102,
+        OK	                                :200,
+        CREATED                             :201,
+        ACCEPTED                            :202,
+        NON_AUTHORITATIVE_INFORMATION       :203,
+        NO_CONTENT	                        :204,
+        RESET_CONTENT                       :205,
+        PARTIAL_CONTENT                     :206,
+        MULTI_STATUS	                    :207,
+        MULTIPLE_CHOICES	                :300,
+        MOVED_PERMANENTLY	                :301,
+        MOVED_TEMPORARILY	                :302,
+        SEE_OTHER	                        :303,
+        NOT_MODIFIED	                    :304,
+        USE_PROXY	                        :305,
+        TEMPORARY_REDIRECT	                :307,
+        PERMANENT_REDIRECT	                :308,
+        BAD_REQUEST	                        :400,
+        UNAUTHORIZED	                    :401,
+        PAYMENT_REQUIRED	                :402,
+        FORBIDDEN	                        :403,
+        NOT_FOUND	                        :404,
+        METHOD_NOT_ALLOWED	                :405,
+        NOT_ACCEPTABLE	                    :406,
+        PROXY_AUTHENTICATION_REQUIRED       :407,
+        REQUEST_TIMEOUT	                    :408,
+        CONFLICT                            :409,
+        GONE	                            :410,
+        LENGTH_REQUIRED                     :411,
+        PRECONDITION_FAILED                 :412,
+        REQUEST_TOO_LONG	                :413,
+        REQUEST_URI_TOO_LONG                :414,
+        UNSUPPORTED_MEDIA_TYPE              :415,
+        REQUESTED_RANGE_NOT_SATISFIABLE     :416,
+        EXPECTATION_FAILED                  :417,
+        IM_A_TEAPOT	                        :418,
+        INSUFFICIENT_SPACE_ON_RESOURCE	    :419,
+        METHOD_FAILURE	                    :420,
+        UNPROCESSABLE_ENTITY                :422,
+        LOCKED	                            :423,
+        FAILED_DEPENDENCY                   :424,
+        PRECONDITION_REQUIRED               :428,
+        TOO_MANY_REQUESTS	                :429,
+        REQUEST_HEADER_FIELDS_TOO_LARGE     :431,
+        UNAVAILABLE_FOR_LEGAL_REASONS	    :451,
+        INTERNAL_SERVER_ERROR	            :500,
+        NOT_IMPLEMENTED	                    :501,
+        BAD_GATEWAY	                        :502,
+        SERVICE_UNAVAILABLE                 :503,
+        GATEWAY_TIMEOUT	                    :504,
+        HTTP_VERSION_NOT_SUPPORTED	        :505,
+        INSUFFICIENT_STORAGE	            :507,
+        NETWORK_AUTHENTICATION_REQUIRED     :511
+    },
+    COLOR: {
+        reset: '\x1b[0m',
+        bright: '\x1b[1m',
+        dim: '\x1b[2m',
+        underscore: '\x1b[4m',
+        blink: '\x1b[5m',
+        reverse: '\x1b[7m',
+        hidden: '\x1b[8m',
+        
+        fgBlack: '\x1b[30m',
+        fgRed: '\x1b[31m',
+        fgGreen: '\x1b[32m',
+        fgYellow: '\x1b[33m',
+        fgBlue: '\x1b[34m',
+        fgMagenta: '\x1b[35m',
+        fgCyan: '\x1b[36m',
+        fgWhite: '\x1b[37m',
+        
+        bgBlack: '\x1b[40m',
+        bgRed: '\x1b[41m',
+        bgGreen: '\x1b[42m',
+        bgYellow: '\x1b[43m',
+        bgBlue: '\x1b[44m',
+        bgMagenta: '\x1b[45m',
+        bgCyan: '\x1b[46m',
+        bgWhite: '\x1b[47m'
+    }
 };