typescript-mock-server 0.0.8 → 0.0.11

package/README.md

@@ -5,25 +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$`. 
-Changes are being picked up automatically, so no need for a restart.
+add a script to you scripts section: `npm run --prefix node_modules/typescript-mock-server start -- --path=/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. When you add files, you have to 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).
 
 # Options
-`--port=x`: Port number the server runs on
-`--path=x`: Path to your models
+- `--port=x`: Port number the server runs on
+- `--path=x`: Path to your models
 
-## Adding GET mocks/stubs
+## 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
@@ -70,7 +71,23 @@ Following dependencies are being used:
 
 ## Roadmap
 - [x] Support other server port
-- [ ] Improve paths/way to start
-- [ ] Support different headers
-- [ ] Support all HTTP methods
+- [x] Improve paths/way to start
+- [ ] Support different headers/configurations (delays, status codes, ...)
+- [x] Support most used 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
+- [ ] Create interface to force implementation of required properties and make it more stable
+- [ ] Improve error handling (missing properties etc.)
+- [ ] Create an optional persistent state
+
+
+## Release notes (will be moved to GitHub in the future)
+- v0.0.11 - Add items to roadmap, bug fixes
+- v0.0.10 - Support multiple http verbs
+
+## Bug fix contributors
+- Path fix, from now on current working directory is used. Credits to [Spoodyman](https://github.com/spoodyman)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-mock-server",
-  "version": "0.0.8",
+  "version": "0.0.11",
   "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",
@@ -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.ts

@@ -3,8 +3,7 @@
 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: { [key: string]: string } = (() => {
   const args = {};
@@ -19,70 +18,71 @@ const argv: { [key: string]: string } = (() => {
   return args;
 })();
 
-console.log(argv);
+console.log(`Passed arguments %o`, argv);
 
 // Create a new express app instance
 const app: Express = express();
 
-const {path, port} = argv;
+const { path, port } = argv;
 
-// @ts-ignore
-const basePath = `${baseDirPath}/${path}`;
+const basePath = `${process.cwd()}/${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);
-
-async function loadModule(moduleName: string) {
-  return await import(moduleName);
-}
+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);
+}
+
 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/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/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/tms-models/users/get-1.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.data = void 0;
-exports.data = {
-    id: 1,
-    firstName: 'Guy',
-    lastName: 'Theuws'
-};

package/tms-models/users/get.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.data = exports.newDate = void 0;
-const newDate = () => new Date();
-exports.newDate = newDate;
-exports.data = [{
-        id: 1,
-        firstName: 'Guy',
-        lastName: 'Theuws',
-        creationDate: (0, exports.newDate)()
-    }, {
-        id: 2,
-        firstName: 'Generation Y',
-        lastName: 'Development',
-        creationDate: (0, exports.newDate)()
-    }];

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

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.data = void 0;
-const get_1 = require("../get");
-exports.data = {
-    id: 1, title: 'Hello profile', user: {
-        id: 1,
-        firstName: 'Guy',
-        lastName: 'Theuws',
-        creationDate: (0, get_1.newDate)()
-    }
-};