typescript-mock-server 0.0.7 → 0.0.10

package/README.md

@@ -5,21 +5,26 @@ 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: `cd node_modules/typescript-mock-server && npm run start -- --path=../../path-to-your-model-directory`. 
-Please note we are changing the directory and therefore, to set the path parameter, you need to go 2 levels up to be in your root. 
-I am looking for a cleaner way of doing this. Your models should export a data const and your file should be named as `^(get|post){1}(-\d)?.ts$`. 
+add a script to you scripts section: `npm run --prefix node_modules/typescript-mock-server start -- --path=$(pwd)/tms-models`. 
+Your models should export a data const and your file should be named as `^(get|post){1}(-\d)?.ts$`. 
 Changes are being picked up automatically, so no need for a restart.
 
-Check out the [working example project](https://github.com/GuyT07/typescript-mock-server-examle) and source [the examples](https://github.com/GuyT07/typescript-mock-server/tree/main/tms-models/users).
+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).
 
-## Adding GET mocks/stubs
+# Options
+- `--port=x`: Port number the server runs on
+- `--path=x`: Path to your models
+
+## Register mocks/stubs
 Examples talk, so lets start with an example.
 
-Your requirement is to have the following endpoints `/users`, `/users/1` and `/users/profile/1`
+Your requirement is to have the following GET endpoints `/users`, `/users/1` and `/users/profile/1`
 
 Create a root folder that contains your models, like `models`. Then add a folder `users` and within the newly created folder 
-create a new folder `profile`. Add following files `get.ts` and `get-1.ts` in the `users` directory, `get-1.ts` in the `profile` dir. You should 
-have the following structure:
+create a new folder `profile`. Add following files `get.ts` and `get-1.ts` in the `users` directory, `get-1.ts` in the `profile` dir. 
+To register another HTTP verb, you replace `get` with your verb ('get', 'post', 'put', 'delete', 'patch', 'options' and 'head' are currently supported).
+
+You should have the following structure:
 
 ```
 --models
@@ -65,8 +70,13 @@ Following dependencies are being used:
 - @types/node
 
 ## Roadmap
-- [ ] Support other server port
-- [ ] Improve paths/way to start
-- [ ] Support different headers
-- [ ] Support all HTTP methods
+- [x] Support other server port
+- [x] Improve paths/way to start
+- [ ] Support different headers/configurations (delays, status codes, ...)
+- [x] Support all HTTP methods
+- [ ] Add tests
+- [ ] Refactor, split up in separate classes (first check if people actually want to use the tool)
+- [ ] Setup CI/CD (+code quality + coverage tooling)
+- [ ] Setup website
+- [ ] Create a JVM compatible version
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "typescript-mock-server",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "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",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "example": "ts-node-dev src/index.ts --path=tms-models",
+    "example": "ts-node-dev src/index.ts --path=$(pwd)/tms-models --port=5000",
     "start": "ts-node-dev src/index.ts"
   },
   "repository": {
@@ -12,12 +12,15 @@
     "url": "git+https://github.com/GuyT07/typescript-mock-server.git"
   },
   "keywords": ["mock server", "testing", "stub", "typescript"],
-  "author": "",
+  "author": "Guy Theuws",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/GuyT07/typescript-mock-server/issues"
   },
   "homepage": "https://github.com/GuyT07/typescript-mock-server#readme",
+  "funding": {
+    "url" : "https://genydev.nl"
+  },
   "devDependencies": {
     "prettier": "^2.6.2"
   },

package/src/index.js

@@ -0,0 +1,133 @@
+#!./../node_modules/.bin/ts-node-dev
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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 });
+const express_1 = __importDefault(require("express"));
+const fs = __importStar(require("fs"));
+const baseDirPath = process.cwd();
+console.log(baseDirPath);
+const argv = (() => {
+    const args = {};
+    process.argv.slice(2).map((element) => {
+        const matches = element.match('--([a-zA-Z0-9]+)=(.*)');
+        if (matches) {
+            // @ts-ignore
+            args[matches[1]] = matches[2]
+                .replace(/^['"]/, '').replace(/['"]$/, '');
+        }
+    });
+    return args;
+})();
+console.log(argv);
+// Create a new express app instance
+const app = (0, express_1.default)();
+// @ts-ignore
+const args = argv['path'];
+// @ts-ignore
+const basePath = `${baseDirPath}/${args}`;
+console.log('basePath:' + basePath);
+function print(path) {
+    var e_1, _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log(path);
+        const dir = yield fs.promises.opendir(path);
+        try {
+            for (var dir_1 = __asyncValues(dir), dir_1_1; dir_1_1 = yield dir_1.next(), !dir_1_1.done;) {
+                const dirent = dir_1_1.value;
+                if (dirent.isDirectory()) {
+                    yield print(`${path}/${dirent.name}`);
+                }
+                else {
+                    handleFile(path, dirent);
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (dir_1_1 && !dir_1_1.done && (_a = dir_1.return)) yield _a.call(dir_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    });
+}
+print(basePath).catch(console.error);
+function loadModule(moduleName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield Promise.resolve().then(() => __importStar(require(moduleName)));
+    });
+}
+app.listen(3000, function () {
+    console.log('App is listening on port 3000!');
+});
+function handleFile(path, dirent) {
+    console.log('File name: ' + dirent.name);
+    if (dirent.name.startsWith('get')) {
+        handleGetRequest(path, dirent);
+    }
+}
+function addEndpoint(endpoint, model) {
+    app.get(endpoint, function (req, res) {
+        res.send(model.data);
+    });
+}
+function handleGetRequest(path, dirent) {
+    console.log('Adding GET request');
+    const endpoint = convertFileNameToEndpoint(path, dirent);
+    console.log('Endpoint: ' + endpoint);
+    const modulePath = `${path}/${dirent.name}`;
+    console.log('Resolve module: ' + modulePath);
+    loadModule(modulePath)
+        .then(model => addEndpoint(endpoint, model))
+        .catch(err => console.error(err));
+}
+function convertFileNameToEndpoint(path, dirent) {
+    let endpoint = `${path.replace(basePath, '')}/${dirent.name}`;
+    endpoint = endpoint.replace('.ts', '');
+    endpoint = endpoint.replace('get', '');
+    if (endpoint !== '') {
+        endpoint = endpoint.replace('-', '');
+    }
+    return endpoint;
+}

package/src/index.ts

@@ -1,12 +1,11 @@
-#!./../node_modules/.bin/ts-node-dev
+#!./node_modules/.bin/ts-node-dev
 
 import express, { Express } from 'express';
 import * as fs from 'fs';
 
-const baseDirPath = process.cwd();
-console.log(baseDirPath);
+type HttpVerb = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
 
-const argv = (() => {
+const argv: { [key: string]: string } = (() => {
   const args = {};
   process.argv.slice(2).map((element) => {
     const matches = element.match('--([a-zA-Z0-9]+)=(.*)');
@@ -19,71 +18,71 @@ const argv = (() => {
   return args;
 })();
 
-console.log(argv);
+console.log(`Passed arguments %o`, argv);
 
 // Create a new express app instance
 const app: Express = express();
 
-// @ts-ignore
-const args = argv['path'];
+const { path, port } = argv;
 
-// @ts-ignore
-const basePath = `${baseDirPath}/${args}`;
+const basePath = `${path}`;
+
+interface RegisteredEndpoint {
+  httpVerb: string;
+  endpoint: string;
+}
+
+const registeredEndpoints: RegisteredEndpoint[] = [];
 
 console.log('basePath:' + basePath);
 
-async function print(path: string) {
-  console.log(path);
+async function readRoutes(path: string) {
   const dir = await fs.promises.opendir(path);
   for await (const dirent of dir) {
     if (dirent.isDirectory()) {
-      await print(`${path}/${dirent.name}`);
+      await readRoutes(`${path}/${dirent.name}`);
     } else {
       handleFile(path, dirent);
     }
   }
+  registeredEndpoints.forEach(endpoint => console.log(`${endpoint.httpVerb.toUpperCase()}   http://localhost:${port}${endpoint.endpoint}`))
 }
 
-print(basePath).catch(console.error);
+readRoutes(basePath).catch(console.error);
+
+app.listen(port || 3000, function() {
+  console.log(`App is listening on port ${port || 3000}!`);
+});
 
 async function loadModule(moduleName: string) {
   return await import(moduleName);
 }
 
-app.listen(3000, function() {
-  console.log('App is listening on port 3000!');
-});
-
 function handleFile(path: string, dirent: fs.Dirent) {
-  console.log('File name: ' + dirent.name);
-  if (dirent.name.startsWith('get')) {
-    handleGetRequest(path, dirent);
-  }
+  const httpVerb = (dirent.name.indexOf('-') > -1 ? dirent.name.split('-')[0] : dirent.name.split('.')[0]) as HttpVerb;
+  handleRequest(path, dirent, httpVerb);
 }
 
-function addEndpoint(endpoint: string, model: any) {
-  app.get(endpoint, function(req, res) {
-    res.send(model.data);
-  });
+function addEndpoint(endpoint: string, httpVerb: HttpVerb, model: any) {
+  app[httpVerb](endpoint, (req, res) => res.send(model.data));
 }
 
-function handleGetRequest(path: string, dirent: fs.Dirent) {
-  console.log('Adding GET request');
-  const endpoint = convertFileNameToEndpoint(path, dirent);
-  console.log('Endpoint: ' + endpoint);
+function handleRequest(path: string, dirent: fs.Dirent, httpVerb: HttpVerb) {
+  const endpoint = convertFileNameToEndpoint(path, dirent, httpVerb);
   const modulePath = `${path}/${dirent.name}`;
-  console.log('Resolve module: ' + modulePath);
+  registeredEndpoints.push({httpVerb, endpoint});
   loadModule(modulePath)
-    .then(model => addEndpoint(endpoint, model))
+    .then(model => addEndpoint(endpoint, httpVerb, model))
     .catch(err => console.error(err));
 }
 
-function convertFileNameToEndpoint(path: string, dirent: fs.Dirent): string {
-  let endpoint = `${path.replace(basePath, '')}/${dirent.name}`;
-  endpoint = endpoint.replace('.ts', '');
-  endpoint = endpoint.replace('get', '');
-  if (endpoint !== '') {
-    endpoint = endpoint.replace('-', '');
+function convertFileNameToEndpoint(path: string, dirent: fs.Dirent, httpVerb: HttpVerb): string {
+  const endpoint = `${path.replace(basePath, '')}/${dirent.name}`
+    .replace('.ts', '')
+    .replace(httpVerb, '')
+    .replace('-', '');
+  if (endpoint.endsWith('/')) {
+    return endpoint.substring(0, endpoint.length - 1);
   }
   return endpoint;
 }

package/tms-models/users/delete-1.ts

@@ -0,0 +1,11 @@
+interface User {
+    id: number;
+    firstName: string;
+    lastName: string;
+}
+
+export const data: User = {
+    id: 1,
+    firstName: 'Guy deleted',
+    lastName: 'Theuws deleted'
+};

package/tms-models/users/get.ts

@@ -5,7 +5,7 @@ export interface User {
     creationDate:  Date;
 }
 
-const newDate = () => new Date();
+export const newDate = () => new Date();
 
 export const data: User[] = [{
     id: 1,

package/tms-models/users/head-1.ts

@@ -0,0 +1 @@
+export const data = null;

package/tms-models/users/options-1.ts

@@ -0,0 +1 @@
+export const data = null;

package/tms-models/users/patch-1.ts

@@ -0,0 +1,11 @@
+interface User {
+    id: number;
+    firstName: string;
+    lastName: string;
+}
+
+export const data: User = {
+    id: 1,
+    firstName: 'Guy patch',
+    lastName: 'Theuws patch'
+};

package/tms-models/users/post-1.ts

@@ -0,0 +1,11 @@
+interface User {
+    id: number;
+    firstName: string;
+    lastName: string;
+}
+
+export const data: User = {
+    id: new Date().getMilliseconds(),
+    firstName: 'Guy created',
+    lastName: 'Theuws created'
+};

package/tms-models/users/profile/get-1.ts

@@ -1,4 +1,4 @@
-import { User } from '../get';
+import { newDate, User } from '../get';
 
 interface Profile {
     id: number;
@@ -10,6 +10,7 @@ export const data: Profile = {
     id: 1, title: 'Hello profile', user: {
         id: 1,
         firstName: 'Guy',
-        lastName: 'Theuws'
+        lastName: 'Theuws',
+        creationDate: newDate()
     }
 };

package/tms-models/users/put-1.ts

@@ -0,0 +1,11 @@
+interface User {
+    id: number;
+    firstName: string;
+    lastName: string;
+}
+
+export const data: User = {
+    id: 1,
+    firstName: 'Guy updated',
+    lastName: 'Theuws updated'
+};

package/nodemon.json

@@ -1,9 +0,0 @@
-{
-  "watch": [
-    "src",
-    "tms-models"
-  ],
-  "ext": ".ts,.js",
-  "ignore": [],
-  "exec": "ts-node ./src/index.ts"
-}