typescript-mock-server 1.11.4 → 1.11.6

package/.junie/memory/language.json

@@ -0,0 +1 @@
+[]

package/.junie/memory/memory.version

@@ -0,0 +1 @@
+3.0

package/README.md

@@ -4,10 +4,37 @@ This makes it easier to maintain your mocks because you can load your own models
 have to update your mock, otherwise you will receive compile errors.
 
 # Quickstart
-The easiest way to check out this stub/mock server is by installing it as a (dev)dependency and then 
-add a script to you scripts section: `npm run --prefix node_modules/typescript-mock-server start -- --path=$INIT_CWD/tms-models`. 
-Your models should export a data const (or a function receiving `req` and `res`) and your file should be named as `^(get|post){1}(-\d)?.ts$`. 
-Changes are being picked up automatically, so no need for a restart. When you add files, you have to restart.
+The easiest way to use this tool is by installing it globally:
+
+```bash
+npm install -g typescript-mock-server
+```
+
+Then you can run it from anywhere using:
+
+```bash
+typescript-mock-server --path=./tms-models
+```
+
+Alternatively, you can install it as a (dev)dependency:
+
+```bash
+npm install --save-dev typescript-mock-server
+```
+
+And add a script to your `package.json`:
+
+```json
+"scripts": {
+  "mock": "typescript-mock-server --path=tms-models"
+}
+```
+
+Or run it directly using `npx`:
+
+```bash
+npx typescript-mock-server --path=tms-models
+```
 
 Check out the [working example project](https://github.com/GuyT07/typescript-mock-server-examle) and [the source](https://github.com/GuyT07/typescript-mock-server/tree/main/tms-models/users).
 
@@ -99,6 +126,7 @@ Following dependencies are being used:
 
 
 ## Release notes (will be moved to GitHub in the future)
+- v1.11.5 - Ensured binary has executable permissions and updated README with better Quickstart instructions.
 - v1.11.4 - Fixed "models not found" error when running as a dependency by removing incorrect path mapping for compiled models and relying on ts-node for raw TypeScript files.
 - v1.11.3 - Fixed module resolution when used as a dependency by explicitly adding ts-node as a dependency and improving its configuration at runtime.
 - v1.11.1 - Added binary support to the package, allowing it to be executed as a command-line tool when installed as a dependency.

package/dist/impl/typescript-mock-server-impl.js

@@ -178,16 +178,6 @@ class TypescriptMockServerImpl {
             const endpoint = this.convertFileNameToEndpoint(dirPath, dirent, httpVerb);
             let modulePath = `${dirPath}/${dirent.name}`;
             this.registeredEndpoints.push({ httpVerb, endpoint });
-            if (__filename.endsWith('.js') && modulePath.endsWith('.ts')) {
-                const distPath = path_1.default.join(process.cwd(), 'dist');
-                const potentialJsPath = modulePath
-                    .replace(process.cwd(), distPath)
-                    .replace(/\.ts$/, '.js');
-                const fs = require('fs');
-                if (fs.existsSync(potentialJsPath)) {
-                    modulePath = potentialJsPath;
-                }
-            }
             yield TypescriptMockServerImpl.loadModule(modulePath)
                 .then(model => this.addEndpoint(endpoint, httpVerb, model))
                 .catch(error => this.log.error(error));

package/dist/src/impl/typescript-mock-server-impl.js

@@ -77,6 +77,18 @@ class TypescriptMockServerImpl {
     }
     static loadModule(moduleName) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (moduleName.endsWith('.ts')) {
+                require('ts-node').register({
+                    transpileOnly: true,
+                    skipProject: true,
+                    compilerOptions: {
+                        module: 'commonjs',
+                        allowJs: true,
+                        esModuleInterop: true,
+                        resolveJsonModule: true
+                    }
+                });
+            }
             return yield Promise.resolve(`${moduleName}`).then(s => __importStar(require(s)));
         });
     }
@@ -167,15 +179,6 @@ class TypescriptMockServerImpl {
             const endpoint = this.convertFileNameToEndpoint(dirPath, dirent, httpVerb);
             let modulePath = `${dirPath}/${dirent.name}`;
             this.registeredEndpoints.push({ httpVerb, endpoint });
-            if (__filename.endsWith('.js')) {
-                const distPath = path_1.default.join(process.cwd(), 'dist');
-                if (modulePath.startsWith(process.cwd()) && !modulePath.startsWith(distPath)) {
-                    modulePath = modulePath.replace(process.cwd(), distPath);
-                }
-                if (modulePath.endsWith('.ts')) {
-                    modulePath = modulePath.replace(/\.ts$/, '.js');
-                }
-            }
             yield TypescriptMockServerImpl.loadModule(modulePath)
                 .then(model => this.addEndpoint(endpoint, httpVerb, model))
                 .catch(error => this.log.error(error));

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "typescript-mock-server",
-  "version": "1.11.4",
+  "version": "1.11.6",
   "description": "Simple mock server that can be used in front end development. Instead of creating json files you can just publish TypeScript objects as json",
   "main": "dist/src/index.js",
   "bin": {
     "typescript-mock-server": "dist/src/index.js"
   },
   "scripts": {
+    "prepare": "npm run build",
     "test": "jest",
-    "build": "tsc --outDir dist && sed -i '' '1s|.*|#!/usr/bin/env node|' dist/src/index.js",
+    "build": "tsc --outDir dist && sed -i '' '1s|.*|#!/usr/bin/env node|' dist/src/index.js && chmod +x dist/src/index.js",
     "example": "npm run build && node dist/src/index.js --path=tms-models --port=5200 --cors=http://localhost:5200",
     "start": "npm run build && node dist/src/index.js",
     "update-deps": "npm update",

package/src/command-line.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Command = void 0;
+var Command;
+(function (Command) {
+    Command["PATH"] = "path";
+    Command["PORT"] = "port";
+    Command["CORS"] = "cors";
+})(Command || (exports.Command = Command = {}));

package/src/impl/command-line-impl.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineImpl = void 0;
+const logger_impl_1 = require("./logger-impl");
+class CommandLineImpl {
+    constructor() {
+        this.arguments = new Map();
+        this.log = new logger_impl_1.LoggerImpl();
+        this.parseCommandLineArguments();
+    }
+    getCommands() {
+        return this.arguments;
+    }
+    getCommand(command) {
+        return this.arguments.get(command);
+    }
+    parseCommandLineArguments() {
+        process.argv.slice(2).map((element) => {
+            const matches = element.match('--([a-zA-Z0-9]+)=(.*)');
+            if (matches) {
+                const value = matches[2].replace(/^['"]/, '').replace(/['"]$/, '');
+                this.arguments.set(matches[1], value);
+            }
+        });
+        this.log.debug(`Passed arguments ${[...this.arguments.keys()].join(',')}`);
+    }
+}
+exports.CommandLineImpl = CommandLineImpl;

package/src/impl/logger-impl.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerImpl = void 0;
+const tslog_1 = require("tslog");
+class LoggerImpl {
+    constructor() {
+        this.log = new tslog_1.Logger({ ignoreStackLevels: 4, displayFunctionName: false });
+    }
+    static getArgumentsToPass(args) {
+        return LoggerImpl.getNumberOfArguments(args) === 1 ? args[0] : args;
+    }
+    static getNumberOfArguments(args) {
+        return args.length;
+    }
+    debug(...args) {
+        this.log.debug(LoggerImpl.getArgumentsToPass(args));
+    }
+    error(...args) {
+        this.log.error(LoggerImpl.getArgumentsToPass(args));
+    }
+    trace(...args) {
+        this.log.trace(LoggerImpl.getArgumentsToPass(args));
+    }
+    warn(...args) {
+        this.log.warn(LoggerImpl.getArgumentsToPass(args));
+    }
+    info(...args) {
+        this.log.info(LoggerImpl.getArgumentsToPass(args));
+    }
+}
+exports.LoggerImpl = LoggerImpl;

package/src/impl/typescript-mock-server-impl.js

@@ -0,0 +1,210 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypescriptMockServerImpl = void 0;
+const express_1 = __importDefault(require("express"));
+const cors_1 = __importDefault(require("cors"));
+const command_line_impl_1 = require("./command-line-impl");
+const command_line_1 = require("../command-line");
+const promises_1 = require("fs/promises");
+const logger_impl_1 = require("./logger-impl");
+const path_1 = __importDefault(require("path"));
+class TypescriptMockServerImpl {
+    constructor(config) {
+        this.log = new logger_impl_1.LoggerImpl();
+        this.commandLine = new command_line_impl_1.CommandLineImpl();
+        this.registeredEndpoints = [];
+        if (config && 'use' in config) {
+            this.app = config;
+            this.basePath = this.getPath();
+        }
+        else {
+            const serverConfig = config;
+            this.app = (serverConfig === null || serverConfig === void 0 ? void 0 : serverConfig.app) || (0, express_1.default)();
+            this.basePath = this.getPath(serverConfig === null || serverConfig === void 0 ? void 0 : serverConfig.path);
+        }
+    }
+    static loadModule(moduleName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (moduleName.endsWith('.ts')) {
+                require('ts-node').register({
+                    transpileOnly: true,
+                    compilerOptions: {
+                        module: 'commonjs',
+                        allowJs: true,
+                        esModuleInterop: true,
+                        resolveJsonModule: true
+                    }
+                });
+            }
+            return yield Promise.resolve(`${moduleName}`).then(s => __importStar(require(s)));
+        });
+    }
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.log.info(`basePath: ${this.basePath}`);
+            const port = this.commandLine.getCommand(command_line_1.Command.PORT) || 3000;
+            const corsSetting = {
+                origin: this.commandLine.getCommand(command_line_1.Command.CORS) || '*'
+            };
+            this.app.use((0, cors_1.default)(corsSetting));
+            // add started endpoint
+            this.addEndpoint('state', 'get', { data: { status: 'started' } });
+            yield this.readRoutes(this.basePath).catch(error => this.log.error(error));
+            this.app.listen(port, () => {
+                this.log.info(`App is listening on port ${port}!`);
+            });
+            this.log.info(`Started mock server on port ${port}`);
+        });
+    }
+    readRoutes(dirPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, e_1, _b, _c;
+            const dir = yield (0, promises_1.opendir)(dirPath);
+            try {
+                for (var _d = true, dir_1 = __asyncValues(dir), dir_1_1; dir_1_1 = yield dir_1.next(), _a = dir_1_1.done, !_a; _d = true) {
+                    _c = dir_1_1.value;
+                    _d = false;
+                    const dirent = _c;
+                    if (dirent.isDirectory()) {
+                        yield this.readRoutes(`${dirPath}/${dirent.name}`);
+                    }
+                    else {
+                        yield this.handleFile(dirPath, dirent);
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = dir_1.return)) yield _b.call(dir_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            const port = this.commandLine.getCommand(command_line_1.Command.PORT) || 3000;
+            this.registeredEndpoints.forEach(endpoint => this.log.info(`${endpoint.httpVerb.toUpperCase()}   http://localhost:${port}${endpoint.endpoint}`));
+            this.registeredEndpoints = [];
+        });
+    }
+    handleFile(dirPath, dirent) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const httpVerb = (dirent.name.indexOf('-') > -1 ? dirent.name.split('-')[0] : dirent.name.split('.')[0]);
+            yield this.handleRequest(dirPath, dirent, httpVerb);
+        });
+    }
+    addEndpoint(endpoint, httpVerb, model) {
+        const route = endpoint.startsWith('/') ? endpoint : `/${endpoint}`;
+        this.app[httpVerb](route, (req, res) => {
+            var _a, _b;
+            let responseData = model.data;
+            let statusCode = (_a = model === null || model === void 0 ? void 0 : model.config) === null || _a === void 0 ? void 0 : _a.statusCode;
+            let delay = (_b = model === null || model === void 0 ? void 0 : model.config) === null || _b === void 0 ? void 0 : _b.delay;
+            if (typeof model.data === 'function') {
+                responseData = model.data(req, res);
+            }
+            if (statusCode) {
+                res.statusCode = statusCode;
+            }
+            if (delay) {
+                setTimeout(() => res.send(responseData), this.getDelayValue(delay));
+            }
+            else {
+                return res.send(responseData);
+            }
+        });
+    }
+    getDelayValue(delay) {
+        if (typeof delay === 'number') {
+            return delay;
+        }
+        else if (delay.min && delay.max) {
+            return Math.floor(delay.min + Math.random() * delay.max);
+        }
+        return 0;
+    }
+    handleRequest(dirPath, dirent, httpVerb) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = this.convertFileNameToEndpoint(dirPath, dirent, httpVerb);
+            let modulePath = `${dirPath}/${dirent.name}`;
+            this.registeredEndpoints.push({ httpVerb, endpoint });
+            yield TypescriptMockServerImpl.loadModule(modulePath)
+                .then(model => this.addEndpoint(endpoint, httpVerb, model))
+                .catch(error => this.log.error(error));
+        });
+    }
+    convertFileNameToEndpoint(dirPath, dirent, httpVerb) {
+        const endpoint = `${dirPath.replace(this.basePath, '')}/${dirent.name}`
+            .replace('.ts', '')
+            .replace(`${httpVerb}-`, '')
+            .replace(httpVerb, '');
+        if (endpoint.endsWith('/')) {
+            return endpoint.substring(0, endpoint.length - 1);
+        }
+        return endpoint;
+    }
+    getPath(defaultPath = 'tms-models') {
+        let definedPath = defaultPath;
+        if (!this.commandLine.getCommands().has(command_line_1.Command.PATH)) {
+            this.log.warn(`Path parameter not set, fallback to default ${defaultPath}`);
+        }
+        else {
+            definedPath = this.commandLine.getCommand(command_line_1.Command.PATH);
+        }
+        if (path_1.default.isAbsolute(definedPath)) {
+            return definedPath;
+        }
+        return path_1.default.join(process.cwd(), definedPath);
+    }
+}
+exports.TypescriptMockServerImpl = TypescriptMockServerImpl;

package/src/impl/typescript-mock-server-impl.ts

@@ -35,6 +35,7 @@ export class TypescriptMockServerImpl implements TypescriptMockServer{
     if (moduleName.endsWith('.ts')) {
       require('ts-node').register({
         transpileOnly: true,
+        skipProject: true,
         compilerOptions: {
           module: 'commonjs',
           allowJs: true,

package/src/index.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const typescript_mock_server_impl_1 = require("./impl/typescript-mock-server-impl");
+const server = new typescript_mock_server_impl_1.TypescriptMockServerImpl();
+server.start().then(() => console.log('Server started')).catch(console.error);

package/src/logger.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/registered-endpoint.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/http-verbs.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/typescript-mock-server.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/tsconfig.json

@@ -1,5 +1,7 @@
 {
   "compilerOptions": {
+    "rootDir": ".",
+
     "target": "es6",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
 
     "module": "commonjs",                                /* Specify what module code is generated. */